-
clone the git repository:
git clone https://github.com/ronerlih/project-3-boiler-authentication -
install dependencies:
npm i -
manually install bcrypt (
npm i bcrypt)- windows: (tricky, make sure to run in powershell in admin mode)
- mac/linux: run with
sudo
-
run localy (dev enviorment):
- install mongoDB and run server locally.
- Set up an
.envfile in root project folder with Redis keys (holds user sessions): REDIS_URL=[your-redis-service-url] REDIS_PASS=[your-redis-service-password] npm start- no cluster:
npm run start:dev-no-cluster - no server side rendering:
npm run start:dev-no-ssr
-
run in production (Heroku):
- build to Heroku:
heroku loginheroku create [unique-name-of-app]- add mongo and redis add-on: on Heroku dashboard, inside your app click add-ons and add 'mLab' form mongodb and 'Redis'.
- check the heroku env variables where added (on settings)
git push heroku master
- build to Heroku:
-
logging: morgan docs
-
user manegement: express-session
-
mongodb ORM: mongoose
-
internal load balancing with cluster: node cluster docs
-
serve compressed: commpression
-
cache and session storage: Redis
- (important!) set up heroku redis eviction policy:
heroku redis:maxmemory --policy=volatile-lru - heroku redis cli:
heroku redis:cli --confirm [heroku-app-name] - e.g. clear redis db (from cli)
FLUSHALL
- (important!) set up heroku redis eviction policy:
-
load tests: loadtest
- suggested test:
loadtest http://localhost:3001/ -k -n 10000 -c 1000 - with cookie (add you cookie value according to session):
loadtest http://localhost:3001/ -k -n 10000 -c 1000 -C cookie-__id=s%3AcvzqMmnAaar3bIknaKsQSsFiQNGbFRC1.c4US2JD17dcuBg1zA46jhdzBuE0O2pglgO6STcQrkCI - on heroku:
loadtest https://mern-stack-boilerplat.herokuapp.com/ -k -n 10000 -c 1000
- suggested test:
-
Docker deployment
- Docker docs
- (Dockerfile config in root)
- commands and process:
docker build -t boiler-docker .docker imagesdocker run -p 49160:3001 -d boiler-dockerdocker swarm -p 3001:3001 -d boiler-dockerdocker pscurl -i localhost:49160- from docker guides: docs
-
load tests with wrk:
- documentation
brew install wrk- i.e.
wrk -t8 -c100 -d30s http://localhost:3001/
- documentation
MERN-BOILERPLATE
├── client // front end (react app)
│ ├── README. md
│ ├── build `to be served in production or on server side rendering`
│ │ ├── asset-manifest.json
│ │ ├── favicon.ico
│ │ ├── index.html
│ │ ├── manifest.json
│ │ ├── precache-manifest.50ab651f5c82451e623a23f949bf95cb.js
│ │ ├── service-worker.js
│ │ └── static
│ ├── package-lock.json
│ ├── package.json // of react app
│ ├── public
│ │ ├── favicon.ico
│ │ ├── index.html
│ │ └── manifest.json
│ └── src
│ ├── App.js // root level component
│ ├── components
│ ├── index.js `root level page`
│ ├── pages
│ └── utils
----------- server -----------
├── index.js // entery point + transpile server from es6 + cluster it (runs server.js)`
├── controllers // routes function/handlers
│ ├── booksController.js
│ ├── serverSideRendering.js
│ ├── userController.js
│ └── workerController.js
├── models // db collections - mongoose
│ ├── book.js
│ ├── index.js
│ └── user.js
├── notes.txt // development notepad
├── Dockerfile // docker config
├── package-lock.json
├── package.json
├── readme.md
├── routes // routing
│ ├── api // api routes
│ │ ├── books.js
│ │ ├── index.js
│ │ ├── user.js
│ │ └── worker.js
│ └── index.js // split to ssr and api routes
├── scripts // modulerizing scripts to here
│ ├── cluster.js
│ ├── errorHandler.js
│ ├── redis.js
│ ├── seedDB.js // seed db collections
│ └── session.js
└── server.js //express server