node-express-mongoose-demo

(โ˜… 5,098)

A simple demo app using node and mongodb for beginners (with docker)

  • .babelrc
  • .dockerignore
  • .env.example
  • .eslintignore
  • .eslintrc
  • .gitignore
  • CODE_OF_CONDUCT.md
  • docker-compose.yml
  • Dockerfile
  • ecosystem.config.js
  • fly.toml
  • LICENSE.txt
  • package-lock.json
  • package.json
  • Procfile
  • README.md
  • SECURITY.md
  • server.js

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/madhums/node-express-mongoose-demo

Downloads the entire project code from GitHub to your computer.

cd node-express-mongoose-demo

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose up -d

Runs the command against the services defined in the compose file.

docker-compose logs -f

Runs the command against the services defined in the compose file.

docker-compose exec node npm i

Runs the command against the services defined in the compose file.

docker-compose exec -e MONGODB_URL=mongodb://mongo:27017/noobjs_test node npm test

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

npm test

Type this command into your terminal and run it.

npm i

Type this command into your terminal and run it.

docker-compose exec node npm i

Runs the command against the services defined in the compose file.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation