Author: Lacy Hogan Version: 1.0.0

This application stores information about user accounts. It takes in a passwordHash, an email, a tokenSeed, and date stamp for when the account is created. PasswordHash, email, and tokenSeed are required fields, with the email and tokenSeed being unique. When a user creates a new account, the new account takes in a username, email, passwordHash, and tokenSeed.

As a user, you will need to have MongoDB installed on your computer.

You will need to include the following scripts in your package.json in order to run the tests and mongod:

"scripts": { "test": "eslint . && jest --coverage --forceExit --runInBand", "lint": "eslint .", "start": "nodemon main.js", "dbon": "mkdir -p ./db && mongod --db path ./db", "dboff": "killall mongod"

You will also need to include the following in order to test your environment:

"jest": { "setupFiles": [ "/src/test/lib/test.env.js" ] },

You will need to init the following dependencies and devDependencies before utilizing this application:

"devDependencies": { "babel-eslint": "^8.2.3", "babel-preset-env": "^1.6.1", "babel-register": "^6.26.0", "eslint": "^4.19.1", "eslint-config-airbnb-base": "^12.1.0", "eslint-plugin-import": "^2.11.0", "eslint-plugin-jest": "^21.15.1", "jest": "^22.4.3", "superagent": "^3.8.2" }, "dependencies": { "bcrypt": "^2.0.1", "body-parser": "^1.18.2", "dotenv": "^5.0.1", "express": "^4.16.3", "faker": "^4.1.0", "http-errors": "^1.6.3", "jsonwebtoken": "^8.2.1", "mongoose": "^5.0.16", "winston": "^3.0.0-rc5" }

This application is written in JavaScript and Node.js. You will need MongoDB installed and utilize body-parser, express, and mongoose middleware.

In order to run tests, first start MongoDB (in windows, run the command: net start mongodb) at the root level. Then, in a separate terminal, run the command: npm run test.

In order to test as CLI, un-comment code in main.js. You will need to ensure that you have nodemon and httpie installed on your computer. Then, in one terminal, run the command: nodemon index.js. Then, in a separate terminal, run the commands:

To POST/CREATE - http POST :7000/api/penguins species=[name of species] firstName=[name] description=[""] gender=[male or female]

• If successful, will respond with a 200 status. If an invalid post is made, will respond with a 400 status

To GET/READ - http :7000/api/penguins id==[insert existing id]

• If successful, will respond with a 200 status. If an invalid get is made, will respond with a 404 status

To PUT/UPDATE - http PUT :7000/api/penguins id==[insert existing id] [species/firstName/description/gender]=[""]

• If successful, will respond with a 200 status. If an invalid put is made, will respond with a 404 status

to DELETE - http DELETE :7000/api/penguins id==[insert existing id]

• If successful, will respond with a 204 status. If an invalid post is made, will respond with a 404 status

05-7-2018 5:30pm - Application POST function created and passing all tests.

Sarah Bixler