A simple, streamlined application for keeping track of the books you have read and the books you want to read.
- Product Owner: Ben Baum
- Scrum Master: Michelle Thorsell
- Development Team Members: Jordan Murphy, Josh Reisenbach
Table of Contents
Fork and clone this repo. From the
mysql> create database booklist; mysql> use booklist;
- Node >= 0.10.41 (tested only on 0.10.41, 0.12.7, and 5.5.0)
- MySQL 5.5.x (higher versions known to be incompatible)
- If you are running MySQL > 5.5.x, we recommend using
homebrewto uninstall your current version and install the correct one. Run
brew uninstall mysql, and then
brew install homebrew/versions/mysql55. If the
mysqlcommand no longer works from the command line, you may have to reference your new version via
/usr/local/opt/mysql55/bin/mysql(and you can create an alias for that path).
From within the root directory:
sudo npm install -g bower sudo npm install -g grunt-cli npm install // runs bower install for you grunt watch:dev // continuous compilation, concatenation, and minification of files npm start // uses nodemon
The server runs on port 8080 by default.
Booting up the server for the first time will create the db schema.
Amazon Web Services
Create an AWS account. In the AWS console, click on your name on the top right of the screen and select Security Credentials from the dropdown. Select Access Keys and note your Access Key ID and Secret Key.
Sign up for the Amazon Associates Program. Note your Tracking ID.
Create an Auth0 account, and specify Amazon as an authentication method. Note your Client ID, Client Secret, and domain.
IMPORTANT: Auth0 credentials must be specified as environment variables (described below), but also in
app.routes.js, specifically in the
.env file in the root directory that you do not commit to version control. Example files can be found on the node-env-file npm page.
The variables you need to define are:
AWS_ACCESS_KEY_ID(AWS access key)
AWS_SECRET_KEY(AWS secret key)
AWS_ASSOCIATES_ID(amazon associates tracking ID)
AUTH_ID(auth0 client ID)
Production: Set these environment variables via your deployment solution (e.g. Heroku).
View the project roadmap here
See _CONTRIBUTING.md for contribution guidelines.