SimAlchemy

Authors: Kate Dameron, Paige Gorry, Teonna Zaragoza, Cari Palazzolo

sim-alchemy.herokuapp.com

Overview

In this back-end app, we built a choose your own code school adventure for the command line. Teachers can log in and post up to 5 assignments to try and better their cohort's grades; includes app-wide unit and end-to-end test coverage.

Technologies used

Node.js, MongoDB, Express, Jest, SuperTest, nodemon, dotenv, Mongoose, morgan, SuperAgent, inquirer, bcrypt.js, figlet, jsonwebtoken, Chance, chalk, gradient-string

Application Structure

.
├── client                   # Play CLI game
├── lib                      # Application, routes, models, home page 
├── test                     # Unit and E2E tests
├── seed.js                  # Load seed data to MongoDB
├── server.js                # Run Express server
├── LICENSE
└── README.md

Getting Started

1. Clone and download GitHub repo

2. Install dependencies:
   npm i

3. Run scripts:
   npm run lint
npm run pretest
npm run test
npm run test:watch
npm run start (start node server)
   npm run start:watch (start nodemon server)
   npm run seed (seed database)
   npm run play (start command line game)
   npm run drop (drop MongoDB)
   npm run db-load-all (drop db and load seed data from scratch)

License

Standard MIT

Acknowledgements

Thank you to Kevin Grayson for suggesting the great app name!