https://github.com/m-mdy-m/twitterclone
Twitter Clone: A simple project using vanilla JS & Node.js. Mimics Twitter's functionality. Built with MongoDB,
https://github.com/m-mdy-m/twitterclone
express nodejs tweet xprz
Last synced: 2 months ago
JSON representation
Twitter Clone: A simple project using vanilla JS & Node.js. Mimics Twitter's functionality. Built with MongoDB,
- Host: GitHub
- URL: https://github.com/m-mdy-m/twitterclone
- Owner: m-mdy-m
- License: mit
- Created: 2024-02-29T12:34:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-02T18:18:38.000Z (over 1 year ago)
- Last Synced: 2024-05-03T04:59:40.905Z (over 1 year ago)
- Topics: express, nodejs, tweet, xprz
- Language: JavaScript
- Homepage:
- Size: 8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitter Clone
This is a simple Twitter clone project built with vanilla JavaScript for the frontend and Node.js for the backend. It utilizes MongoDB as the database for storing tweets.
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
You need to have the following software installed on your system:
- Node.js
- MongoDB
### Installing
1. Clone the repository to your local machine:
```
git clone https://github.com/m-mdy-m/TwitterCone.git
```
2. Navigate to the project directory:
```
cd twitter-clone
```
3. Install dependencies:
```
npm install
```
### Setting Up MongoDB
1. Make sure MongoDB is installed and running on your system.
2. Create a new database named `twitter_clone`.
### Configuration
1. Create a `.env` file in the root directory of the project.
2. Add the following environment variables to the `.env` file:
```
PORT=3000
MONGODB_URI=mongodb://localhost:27017/twitter_clone
```
### Running the Server
Start the server by running the following command:
```
npm start
```
The server will be running on port 3000 by default.
## Usage
Once the server is running, you can access the application by navigating to `http://localhost:3000` in your web browser.
## Contributing
Feel free to contribute to this project by submitting pull requests or reporting issues.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/m-mdy-m/NexTweet/blob/main/LICENSE) file for details.