QA Library website using the Mongo Express React Node stack

Quick Start

• Install dependencies by running npm install.
• Install client dependencies by running npm run install:client.
• See the readme's in the associated directories for more info about each
• Add .env file with the following info:

PORT=5001

NODE_ENV=<dev, production>

DB_USER=

DB_PASS=

CLIENT_ID=(For github authentication)

CLIENT_SECRET=(For github authentication)

HOST=http://localhost:5001

JWT_SECRET=

• Run npm run build:client to build the client app for serving
• Run npm start to start the mongo db connection and serve the app on localhost 5001
• 😎 That's it!

Available Scripts

npm start

Starts up the mongo db connection and serve the app on localhost 5001

npm run test:unit

Runs unit tests on the models

npm run test:api

Runs api tests. Be sure to set the .env to run on the dev environment

npm run lint:client

Runs linting on the client project

npm run test:unit:client

Runs unit tests on client components

npm run test:accessibility:client

Runs accessibility tests on client components

npm run test:snapshot:client

Runs snapshot tests on client components

npm run build:client

Builds the client application for serving

test:cypress:startAndOpen

Spin up the library locally and open cypress to run tests

Docker Run - Improvements can be made

docker build -t <Tag> .

Builds the image based on the current state of the app

docker run -p 4000:5001 <Tag>

Creates and runs a container based on the created image

Jenkins setup

See the following tutorial for spinning up jenkins running the pipeline:

https://jenkins.io/doc/tutorials/build-a-node-js-and-react-app-with-npm/#fork-sample-repository

Built using

• Express
• Mongoose
• Mocha
• Mongoose-sequence
• Chai
• Create-React-App