ashrash/backendNode

A Node starter app with typescript

NodeJs Backend Challenge

Tech: Node + Express + MongoDB/Mongoose + Typescript + Swagger + Docker

An App with CRUD Operations on User and Hobbies collection on MongoDB.

MongoDb database is hosted at MongoDB Atlas, Backend service is hosted at Digital Ocean

CI/CD setup using github action: Build script

Folder structure

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

Running App in DEV mode

Before running the below command set DB_CONNECTION_STRING env variable with the desired connection string.

#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