Full-Stack Sequelize Template

this template is meant to get you up-and-running with a full-stack web application scaffolded out and ready to run using node, express, and sequelize. happy coding.

Useful Features

• 'dotenv' environmental variables package configured for sequelize
• nodemon package configured
• ESlint package configured for Airbnb styleguide
• heroku-deployment ready
• instructions to create separate development and production databases
• instructions for migrating and seeding databases

How to Use This Template

• click "use template" next to the clone button, this will create a new repository on your github account
• clone the repository down to your machine
• run the schema.sql query in the mySQL tool of your choice
• run   npm install
• run   touch .env  in the root of your repository
• open the .env file
• add the four environmental variables that will be used to connect to the database:
         DB_PASSWORD=yourpassword
       DB_HOST=127.0.0.1
       DB_USER=root
       DB_NAME=sample_db
• run   npm start to start the server with nodemon which will automatically refresh after any server-side code changes
• check out the optional migrations and heroku deployment guides below!

Optional Database Migrations and Seeding

Hey, this part can be confusing and is waaay beyond the scope of this readme to fully explain...if you choose to implement this useful functionality, you will need to refer to the documentation!

If you dont want to set up migrations at the moment, you can always come back to it, just skip ahead to the "Heroku Deployment" section

• Sequelize-cli allows you to create models and seed your database from the command line
• This will allow you to pre-fill your database for development, as well as provide a consistent data set for testing accross multiple collaborators
• Please refer to the instructions below and Sequelize migrations documentation to configure this project for migrations

Optional Instructions for Implementing Migrations

• run two sequelize-cli commands to initialize the migrations and seeders folders

    npx sequelize-cli init:migrations
  

  and

    npx sequelize-cli init:seeders
  

• run

    npx sequelize-cli model:generate --name <ModelName> --attributes <someAttribute>:string,<anotherAttribute>:boolean
  

  entering in the model name and the attribute you are initializing it with - for example:

    npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string
  

• this will create the model in the models folder, and a migration file in the migrations folder.

• you will need to go to the model file and finish setting it up, add validation, etc.

• you will also need to set up your migrations file to match your model before running the migration

• Once you have set up your model and matching migration, you can run the migration to create the table in your database:

    npx sequelize-cli db:migrate
  

• Next we will create a seed file that will allow us to populate the table with a dataset on command, allowing us to share a consistent dataset accross collaborators, as well as revert the table back to a clean state after testing.

    npx sequelize-cli seed:generate <SEED NAME HERE, EX. DEMO-USER>
  

• Open the seed file created in the seeders folder and set up your seed data. for example:

• once you have filled in your seed file you can run it:

    npx sequelize-cli db:seed:all
  

• you are now all set to push everything up to github and continue with the steps below to deploy to heroku.

• the final step will be to seed your production database as well. See the optional last step in the heroku deployment section.

Heroku Deployment

• you may need to log into the heroku cli, do so by running   heroku login   in the terminal, you will also need the heroku website so might as well log in there too
• run  heroku create in the root of your project repository.
• you can now run git push heroku master to push your application to heroku in its current state. You will need to do this each time you wish to rebuild your heroku deployment. You can also set up your repository to automatically push to heroku when you push to github -look around, you will find it!
• select your application on the heroku website
• click "Configure Add-ons"
• type "JawsDB" into the search bar, select "JawsDB MySQL" and provision the "Kitefin Shared - Free" default option
• open the JawsDB instance you have created by clicking on it
• you will be brought to a page with the connection information for your deployed database, which you will need to establish a connection to your production database in the MySQL management tool of your choice

• now it is time to create an instance of your production database in your MySQL management tool. The following instructions are specifically for MySQL Workbench, but they should apply in a general sense to any tool you are using.
• create a new MySQL connection instance

• give your connection a meaningful name, then using the information from the JawsDB Connection Info page, fill in the connection information on the new connection dialog, click the "store in keychain" button and store your password

• test you connection by clicking the "Test Connection" button at the bottom of the dialog
• if your connection fails, double check that you copied the information correctly
• if your connection succeeds, click into the instance
• don't be alarmed if your schemas panel looks like this, you will still be able to view and query the database:

• to run queries, dont forget your USE <DATABASE NAME>; statement, using the database name you see in the schemas panel:

• now you can manage your deployed production database!

• Optional last steps when using migrations:

• To seed your production database, add the following line to the scripts in the   package.json   file, right below the start script:

    "heroku-postbuild": "npx sequelize-cli db:migrate && npx sequelize-cli db:seed:all"
  

• save and commit your changes to github, then run another

    git push heroku master
  

  to push the changes to heroku and run a fresh build. The script that was added will run the migration and seed at the end of the heroku build.

• select * ...   within your database management tool to see your freshly seeded production database! Note that the database will be re-seeded each time you run a build, and the build does not drop the table automatically. So to avoid doubling your data set, drop the table prior to running another build (you can use your management tool for this). If you do not wish to continue re-seeding your production database, as you surely will at some point, just remove the "heroku-postbuild" script from the package.json file.

Notes About This Database Configuration

• you now have two databases, a local development database and a deployed production database

• when running your application locally as you develop, it will connect to the local development database using the credentials you supplied in your .env file

• the heroku-deployed application will connect automatically to the deployed production database

• if at any point you with to revert to a clean data set, run the migration/seeder instructions above. Heroku has a cli that can be accessed by running

    heroku run bash <name of application>
  

  this will allow you to run the migration and seed commands on the production database manually by running the npx sequelize-cli... commands detailed above.

• remember that the heroku postbuild script in the package.json file is optional and may or may not be worth keeping in for you if you use the heroku cli tool. It will append the seedfile dataset to the database each time the application is pushed to heroku. You can also drop the table using your management tool prior to running another heroku build.

To Disable ESLint

• delete the .eslintrc.js file
• run   npm uninstall eslint

Links and Resources

• eslint Getting started page
• dotenv NPM Documentation
• airbnb styleguide documentation