Skip to content

Latest commit

 

History

History
34 lines (31 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

34 lines (31 loc) · 1.62 KB

Contribute to tabbit

Developer environment

Requirements

Setting up a local environment

  1. Install npm packages, run npm install
  • Also installs the bower front-end packages in client/bower_components
  1. Start the server, run heroku local (runs npm start with heroku configs)
  • Initializes the local database if it does not exist
  • Runs the app/server at http://localhost:5000
  • Runs a local instance of the app as if it were hosted on heroku (more info)
  1. Run all database seeders, run sequelize db:seed:all
  • Runs all database seeds located in the server/seeders folder
  • This only needs to be run once per database instance unless new seeds are added

Testing file uploads

In order to test the upload functionality, you will need to create an Amazon AWS S3 instance. TODO: Add instructions for creating Amazon AWS S3 instance, privacy settings, etc. TODO: Add instructions for creating the .env heroku app settings configuration file

Heroku deployment notes

  1. Push code onto Heroku
  • By connecting GitHub or pushing to Heroku git.
  1. Add a Heroku Postgres database add-on
  • This sets a config variable, DATABASE_URL
  1. Set config variables
  • AWS_ACCESS_KEY: AWS account access key
  • AWS_SECRET_KEY: AWS account secret key
  • AWS_S3_BUCKET: AWS S3 bucket name
  • JWT_SECRET: JWT token secret
  1. Seed the database, run heroku run sequelize db:seed:all