Tweeter

🔗 Tweeter

Tweeter is a simple, single-page Twitter clone.

Table of Content

• 🔗 Tweeter
• Table of Content
• 🌟 Features
• 🚀 Getting Started
• ⚫ Endpoints
• 🧱 Main Structure
• 📦 Tech Stack (Dependencies)
  • 🔨 Dependencies
  • 🧰 Development Dependencies
• ⚠️ Disclaimer

🌟 Features

• Create tweets under 140 characters.
• Hide and show new tweet input box.
• Return to top button when scrolling page.

🚀 Getting Started

1. Fork repository.
2. Install all dependencies using the npm install command.
3. Run the server using the npm start command.
4. Visit http://127.0.0.1:8080 or localhost:8080 in your browser (port defaults to 8080).
5. Tweet away.

⚫ Endpoints

• Base URL : http://127.0.0.1:8080

Http method	path	Description
GET	/	Gets index page and retrieves all the posts of a user
POST	/	Creates a new post and adds it to all displayed posts

🧱 Main Structure

├─── .github                # note to students
├─── public                 
│  ├─── images              # contains proflie pic
│  ├─── scripts             # contains client side scripts
│  ├─── styles              # contains all the css files
│  ├─── vendor              # contains css normalization and jquery scripts
│  ├─── index.html          # main page
├─── server             
│  ├─── data-files          # mock tweets
│  ├─── lib                 
│  |  ├─── util             # contains all the helper functions
│  ├─── routes              # app routes
│  ├─── index.js            # the main driver of the app includes all the routes and server configs
├─── .gitignore
├─── README.md
├─── package-lock.json
└─── package.json

📦 Tech Stack (Dependencies)

🔨 Dependencies

• Express.js
• Body-Parser
• Chance
• MD5

🧰 Development Dependencies

• Nodemon

⚠️ Disclaimer

• This is a project for LHL web development bootcamp and is not meant for production use.