OjerIsaac/twitee

This is the backend service of a mini and substandard runoff of Twitter powered by Nodejs, Express and TS

INTELLIGENT INNOVATIONS BACKEND DEVELOPER ASSESSMENT

This is the backend service of a mini and substandard runoff of Twitter powered by Nodejs, Express and TS

About Task

• TWITEE is a mini and substandard runoff of Twitter. Users register and login and can put up anything that crosses their mind. The whole world can view their twits and comment on their twits /and like them

Project Features

• User can register
• User can login
• User can post twits
• User can delete twits (if owned by the user)
• User can add comments under twits
• User can like twits (only once)
• User can see posted twits and comments under twits
• User can logout

Requirements

• NodeJS runtime
• NPM or Yarn package manager
• Postgres Database

Code Features

• Completely written in Typescript
• Express Nodejs framework
• MySQL The world's most popular open source database
• Objection.js SQL ORM for Nodejs
• Knexjs SQL query builder

How to install

• Clone the repository
• git clone https://github.com/OjerIsaac/twitee.git
• cd twitee
• Install dependencies
• npm install
• Setup environment variable
• cp .env.sample .env
• Fill in data for db (Postgres)
• Run Migration
• npm run migrate:latest
• To seed db
• npm run seed:run
• Run the server in dev env
• npm run dev

Documentation link

• The endpoints for test of the service are provided in the Postman Documentation.

Miscellaneous

• Base url: https://twitee-api.vercel.app/
• Post twit: /twit/{:userId}/post-twit
• Delete Twit: /twit/{:userId}/delete-twit/{:twitId}
• Post comment: /twit/{:twitId}/post-comment/{:userId}
• Like Twit: /twit/{:twitId}/like-twit/{:userId}