Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sojijr committed Feb 4, 2024
1 parent 50e4233 commit fbb65bc
Showing 1 changed file with 62 additions and 7 deletions.
69 changes: 62 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,79 @@
# Valentine Website

A valentine website for your bae
A valentine website for your bae <br>
This project gives you a template to use and edit for your valentine website instead of building one from scratch <br>

## Attribution
Edit the 'script.js' file to customize the message and 'send_mail.php' file to send an email from your email address.

---

This project is based on [in-all-the-stars](https://github.com/KalDrongo/in-all-the-stars), created by [KalDrongo
](https://github.com/KalDrongo).

Features added:
*Features added:*

- background stars blinking
- cursor change
- mobile responsiveness
- send email functionality

## Third-Party Libraries
## ⚒️ Languages / Library
- HTML
- CSS
- Javascript
- PHP
- [PHPMailer](https://github.com/PHPMailer/PHPMailer)


## 💻 Demo

Check out the demo website: [Valentine-website](https://sojijr.github.io/valentine-website/)

## How to use
Click [`Use this template`](https://github.com/sojijr/valentine-website/generate) and it will create a new repo not a fork with all the files of this project for you.

![image](https://user-images.githubusercontent.com/78784850/198232353-35fa6d2f-5816-4818-9381-a5bf394b146a.png)

## Prerequisites to use 👇🏽
- [Composer](https://getcomposer.org/) - to use
before installation, please make sure you have it already installed.

## 🛠️ Installation Steps

1. After generating a new repo using this template, clone the project, you can use the following command:

```bash
git clone https://github.com/<your-github-username>/valentine-website
```

2. Move the cloned repository to Xampp/htdocs or wamp64/www <br>

3. Navigate to the project directory

```bash
cd Xampp/htdocs/valentine-website or wamp64/www/valentine-website
```

4. Install dependencies with composer install

```bash
composer install
```

5. Run the project by entering the URL below on your browser to run it

```bash
http://localhost/valentine-website/
```

## 👩🏽‍💻 Contributing

- Any contributions you make are greatly appreciated.

This project uses [PHPMailer](https://github.com/PHPMailer/PHPMailer), which is licensed under the GNU Lesser General Public License (LGPL) version 2.1.
## 🛡️ License

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

This project is licensed under the [MIT License](LICENSE).
## 🙏🏽 Support

This project needs a star️ from you. Don't forget to star it✨

0 comments on commit fbb65bc

Please sign in to comment.