ShoroukAziz / my-tweeter

🐣Tweeter

Better than Twitter!

Tweeter is A simple, single-page Twitter clone.

Table of Content

• 🐣Tweeter
  • Better than Twitter!
    • Tweeter is A simple, single-page Twitter clone.
  • Table of Content
  • 🌟 Features
  • 🚀 Getting Started
  • Product Overview
  • 📦 Tech Stack (Dependencies)
    • 🔙 Backend
    • 🧰 Development Dependencies
    • 👁‍🗨 Frontend Dependencies
  • 🙈 Know issues
  • ⚠️ Disclaimer

🌟 Features

• Responsive Design, works with with all screen sizes
• Single page application ie. no refreshing needed. all the requests are done with AJAX
• Interactive design
  • Characters counter
  • Toggle the form
  • like tweets

---

🚀 Getting Started

• clone the repo
  git clone <repo> my-tweeter
• Navigate to the repo
  cd my-tweeter
• Install all the depndencies
  npm install
• Run the server:
  npm run local
  
• Visit the app in your browser: http://127.0.0.1:8080/
• Start Tweeting 🐥🎉🎇

---

Product Overview

• Tweet

• Toggel form

• Scroll button

• user error messages

• server messages

• Small screen

  

• Medium screen

• Large screen

---

📦 Tech Stack (Dependencies)

🔙 Backend

• Express
• body-parser
• chance
• md5

🧰 Development Dependencies

• Nodemon
• Sass

👁‍🗨 Frontend Dependencies

• FontAwesome
• jQuery

---

🙈 Know issues

• The liking function is just front-end effect and won't persist if you refresh the page

---

⚠️ Disclaimer

• This is a project for LHL web development bootcamp and is not meant for production use
• The starter code for this project was provided by LHL and comes from here

⬆ Go to beginning