|
| 1 | +--- |
| 2 | +title: "Tea Addicts" |
| 3 | +date: 2024-08-24 |
| 4 | +author: Exonymos |
| 5 | +description: "A fun website that counts the number of sips of tea taken by users globally." |
| 6 | +keywords: ["tea", "counter", "sips", "global"] |
| 7 | +tags: ["web app", "firebase", "javascript"] |
| 8 | +--- |
| 9 | + |
| 10 | +## Overview |
| 11 | + |
| 12 | +Tea Addicts is a fun and interactive web application that allows users to count the number of sips of tea taken globally. Each time a user clicks the "Sip Some Tea" button, the counter increments, and a random sipping sound is played. The global count is stored and synchronized using Firebase Firestore. |
| 13 | + |
| 14 | +### Quick Links |
| 15 | + |
| 16 | +<div align="center"> |
| 17 | + <a href="https://exonymos.github.io/projects/Tea-Addicts/" target="_blank"> |
| 18 | + <img src="https://img.shields.io/badge/live-website-0064b4?style=for-the-badge&labelColor=black&logo=vercel" alt="Live Website"> |
| 19 | + </a> |
| 20 | + <a href="https://github.com/Exonymos/projects/tree/614c31a94cb69ec83d90d95fe5e851e0cf2572f8/Tea-Addicts" target="_blank"> |
| 21 | + <img src="https://img.shields.io/badge/view-source-c34300?style=for-the-badge&labelColor=black&logo=github" alt="View Source"> |
| 22 | + </a> |
| 23 | +</div> |
| 24 | + |
| 25 | +## Features |
| 26 | + |
| 27 | +- Real-time global tea sip counter |
| 28 | +- Random sipping sounds for each sip |
| 29 | +- Responsive design |
| 30 | +- Error handling for network issues |
| 31 | + |
| 32 | +## Setup |
| 33 | + |
| 34 | +To set up the project locally, follow these steps: |
| 35 | + |
| 36 | +1. **Clone the repository:** |
| 37 | + |
| 38 | + ```sh |
| 39 | + git clone https://github.com/Exonymos/projects/tree/614c31a94cb69ec83d90d95fe5e851e0cf2572f8/Tea-Addicts.git |
| 40 | + cd tea-addicts |
| 41 | + ``` |
| 42 | + |
| 43 | +2. **Install dependencies:** |
| 44 | + This project uses Firebase, so make sure you have an internet connection to load the Firebase SDKs. |
| 45 | + |
| 46 | +3. **Configure Firebase:** |
| 47 | + |
| 48 | + - Create a Firebase project at [Firebase Console](https://console.firebase.google.com/). |
| 49 | + - Replace the Firebase configuration in `js/app.js` with your project's configuration. |
| 50 | + |
| 51 | +4. **Run the project:** |
| 52 | + Open `index.html` in your web browser. |
| 53 | + |
| 54 | +## Usage |
| 55 | + |
| 56 | +- Open the web application. |
| 57 | +- Click the "Sip Some Tea" button to increment the global sip counter. |
| 58 | +- Enjoy the random sipping sounds! |
| 59 | + |
| 60 | +## Contributing |
| 61 | + |
| 62 | +We welcome contributions! To contribute: |
| 63 | + |
| 64 | +1. Fork the repository. |
| 65 | +2. Create a new branch (`git checkout -b feature-branch`). |
| 66 | +3. Make your changes. |
| 67 | +4. Commit your changes (`git commit -m 'Add some feature'`). |
| 68 | +5. Push to the branch (`git push origin feature-branch`). |
| 69 | +6. Open a pull request. |
| 70 | + |
| 71 | +## License |
| 72 | + |
| 73 | +This project is licensed under the MIT License. See the [LICENSE](https://github.com/Exonymos/projects/blob/614c31a94cb69ec83d90d95fe5e851e0cf2572f8/LICENCE) file for details. |
| 74 | + |
| 75 | +## Contact |
| 76 | + |
| 77 | +If you have any questions or suggestions, feel free to contact me at [GitHub](https://github.com/Exonymos). |
0 commit comments