https://github.com/ize-302/twitter-clone-api

A tiny app implementing twitter core feature 🐦
https://github.com/ize-302/twitter-clone-api

api expressjs nodejs postgresql postman rest-api typescript

Last synced: about 1 month ago
JSON representation

A tiny app implementing twitter core feature 🐦

• Host: GitHub
• URL: https://github.com/ize-302/twitter-clone-api
• Owner: ize-302
• Created: 2023-08-03T12:37:55.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-04T07:51:01.000Z (over 1 year ago)
• Last Synced: 2024-04-28T06:05:30.544Z (7 months ago)
• Topics: api, expressjs, nodejs, postgresql, postman, rest-api, typescript
• Language: TypeScript
• Homepage:
• Size: 179 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Twitter clone API 🐦

A tiny app implementing twitter core feature

#### Tech Stack

- [TypeScript](https://www.typescriptlang.org/)

- [NodesJS](https://nodejs.org/)

- [ExpressJS](https://expressjs.com/)

- [PostgreSQL](https://www.postgresql.org/) hosted on ([ElephantSQL](https://www.elephantsql.com/))

#### Database Structure / Relationships 💾

![Alt text](image.png)(https://drawsql.app/teams/team-ize/diagrams/twitter-clone-db)

#### How to run 🏃

- Clone the repo

- Run `npm install` to install dependencies

- Create a .env file with content from [env.example](env.example)

- Run `npm run start:dev` to run in development mode

- This usually runs on port 3000 unless otherwise stated

#### Todos

- Refresh token implementation

- Timeline feed

- Fetch user's tweets, replies, liked tweets

- Retweet feature

### API Documentation

[API Documentation on Postman](https://documenter.getpostman.com/view/7097316/2s9XxyPsdx#cec8e4d7-9722-45f5-9da0-374a8c165fe0)