diff --git a/README.md b/README.md index 875fec568791ef4689bef5ea37a37ec7320001e6..c3210262857858657031ae3aac052d73cffe80ae 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# express-template -This is a template repository for creating express applications. +# express-template repository + +This is a template repository for creating express applications. It uses pre defined node modules to help speed up production. + +## Getting started + +### Install node modules: +```bash +npm install +``` + +### Start development server using nodemon: +```bash +npm start dev +``` + +### Start production server: +```bash +npm start +``` + +## Used node modules + +Dependencies: +- `Express` +- `EJS` +- `Mongoose` + +Dev dependencies: +- `Nodemon` + +## Shoutout + +- `normalize.css` (https://necolas.github.io/normalize.css/) \ No newline at end of file