Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yossefmohamed/twitter-clone

Twitter clone is an effort to rewrite some of Twitter's functionality using modern Typescript. It was mostly an effort to learn Node.js and trying to reverse engineer some of twitter's feature.
https://github.com/yossefmohamed/twitter-clone

express-session expressjs mongodb mongoose nodejs pugjs

Last synced: about 2 months ago
JSON representation

Twitter clone is an effort to rewrite some of Twitter's functionality using modern Typescript. It was mostly an effort to learn Node.js and trying to reverse engineer some of twitter's feature.

Awesome Lists containing this project

README

        

# twitter-clone

Table of Contents



  1. About The Project


  2. Demo


  3. Getting Started


  4. To-Do

  5. Contact

## About The Project
Twitter clone is an effort to rewrite some of Twitter's functionality using modern Typescript. It was mostly an effort to learn Node.js and trying to reverse engineer some of twitter's feature.

(back to top)

### Built With

This project is built with :

![Node.Js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![MongoDb](http://img.shields.io/badge/-MongoDb-white?style=flat-square&logo=mongodb)
![Npm](http://img.shields.io/badge/-Npm-white?style=flat-square&logo=npm&logoColor=white)
[![Bootstrap][Bootstrap.com]][Bootstrap-url]
[![JQuery][JQuery.com]][JQuery-url]

(back to top)

## Demo

to see the live demo [Live Demo](https://twitter-clone-6ij7.onrender.com/)

(back to top)

## Getting Started

Here's a few steps to get strat with the project:

### DOTENV variable :

create .env file in the src dir with the following values:

| Variable | Example |
| ---------- | ------------------------------ |
| dbURI | mongodb://localhost:27020/mydb |
| JWT_SECRET | MY_SECRET |
| PORT | 5000 |

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* nodejs
you have to install nodejs on your machine
* mongodb
you have to install mongodb on your machine
* npm
```sh
npm install npm@latest -g
```

### Installation

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
2. Install NPM packages
```sh
npm install
```

(back to top)

## To-Do

- [ ] Build the UI with Reactjs "NextJs"
- [ ] Add trends
- [ ] make mobile app using React Native
- [ ] Multi-language Support
- [ ] Arabic
- [ ] English

(back to top)

## Contact

Yossef Mohamed - [My LinkedIn](https://www.linkedin.com/in/yossef-mohamed-57996a181/) - [email protected]
Project Link: [https://github.com/YossefMohamed/twitter-clone](https://github.com/YossefMohamed/twitter-clone)

If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕

Buy Me A Coffee

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com