* Getting Started

1. npm install from the root directory

2. update the server/config/config.json development object with your database settings

• the production object is setup for deployment to Heroku
• we recommend adding config.json to your .gitignore until you're ready for deployment

3. npm run db:setup to run database migrations and seeders

4. register a new OAUTH application w/ GitHub (link)

• homepage url: http://127.0.0.1:3000
• authorization callback url: http://127.0.0.1:3000/auth/github/callback

5. add a github-config.js file to your server/config folder

• verify that this file is in your .gitignore

6. add the following to github-config.js

var github = {
  clientID: 'UPDATE ME WITH YOUR GITHUB CLIENT ID',
  clientSecret: 'UPDATE ME WITH YOUR GITHUB CLIENT SECRET',
  callbackURL: 'http://127.0.0.1:3000/auth/github/callback'
};

module.exports = github;

• server/githubAuth.js is using ^ these credentials

7. use npm start to start the server - you may also use npm run start:dev to start the server w/ nodemon

8. access the server locally through http://127.0.0.1:3000

• if you have issues loading the stylesheet, verify that you're using http and not https in the address bar

---

For more info on setting up the database see: database