virgil-av / nodejs-express-mongoose-typescript-docker-api-example

An example app built with NodeJS, Express Mongoose Typescript and deployed with Docker

NodeJS App written in Typescript, using Express and MongoDB, deployed via Docker

Created this app to improve my JavaScript knowledge and transition from Frontend to Full-Stack JavaScript.

---

Read Me !!!

• This is a Proof Of Concept I did in 2019
• Due to old libraries the typescript app will only compile with Node.js 11.
• Download link here -> https://nodejs.org/en/download/releases/
• In the near future I will update this repo with the latest bcrypt and other libraries but until then either use an older version of NodeJs or you can update the code to your convenience. (Don't mind pull requests)

---

Local machine setup

• install NodeJS on your local machine (https://nodejs.org/en/)
• install docker-compose on your machine (https://docs.docker.com/compose/install/)

Local project setup

• clone or download this repo
• open terminal (powershell etc.) in the project folder
• run npm install
• compile the app (look in package.json) npm run build
• if you get any tsc error you might need to install typescript globally (npm i -g typescript)
• run docker-compose up, this will create 3 containers mongo (port 27017), mongo-express (port 8081), demo-app (port 8888)

Project details

• navigate to localhost:8081 for mongo-express you will access the gui for mongo
• navigate to localhost:8888/api/api-docs for swagger documentation