BookWorms

Bookworms! an online metacritic for books

Team

• Product Owner: Paul Marinaro
• Scrum Master: Alec Gilchrist
• Development Team Members: Paul Marinaro, Alec Gilchrist, Joshua Blankenship

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Environment Variables
   3. NPM Scripts
4. Team
5. Contributing

Usage

This projects uses:

• React v15
• Express v4
• MongoDB through Mongoose v5

Requirements

• Node 4.x
• Mongo 3.x

Development

Installing Dependencies

From within the root directory:

npm install

Environment Variables

Ensure your environment variables are setup correctly. View the environment docs here

NPM Scripts

npm run server-dev:server # start server with nodemon
npm run react-dev:client # start client webpack server

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.