README.md

Oslashclone

Tech: Node + Express + MySQL/sequelize + Typescript + Swagger + Docker

Folder structure

├── .github/workflows
├── src
│   ├── config
│   ├── controllers
│   ├── interfaces
│   ├── middleware
│   ├── models
│   ├── routes
│   ├── services
│   ├── tests
│   ├── utils
│   ├── app.ts
│   └── index.ts

Running App in DEV mode

#Install dependencies
npm i 

#Start app in dev mode. Default port: 3000
npm run dev 

Running Tests

Make sure the app is running using the above command.

npm run test

Swagger endpoint

http://localhost:3000/api-docs

The kind of API chosen - Rest API

The kind of authentication mechanism - Basic Username and password auth with JWT.

The database chosen - Mysql

Table(s) design -

added feat1