Add README.md

This commit is contained in:
Andrew Trieu
2024-02-27 13:56:36 +02:00
parent 9becf8117b
commit 9ea465df89
2 changed files with 31 additions and 0 deletions

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# ChatLine - Real-time Messaging App
ChatLine is a real-time messaging app that allows users to send and receive messages in real-time. Users can create an account, log in, and send messages to other users. The app is built using JavaScript, PHP, and MySQL.
## Features
- User authentication
- Real-time messaging
- User search
- User online/offline status
- User last seen status
## Deployment
The app is deployed on Heroku. You can access the app [here](https://chatline-f5e4ccce6986.herokuapp.com/).
## Local Setup
1. Clone the repository
2. Install [XAMPP](https://www.apachefriends.org/index.html)
3. Start the Apache and MySQL servers
4. Create a new database in phpMyAdmin
5. Import the `chatline.sql` file into the database
6. Update the database credentials in `config.php`
7. Copy the repository to the `htdocs` folder in the XAMPP directory
8. Open the app in a web browser using the URL `http://<your-localhost>/chatline/`
## Disclaimer
Based on [this project](https://www.youtube.com/watch?v=VnvzxGWiK54&ab_channel=CodingNepal).

View File

@@ -0,0 +1 @@
{}