/macro_tracker

Primary LanguageRuby

Weekly Macro Tracker

Converting the Weekly Macro Tracker spreadsheet application to a Rails / React app with user accounts

Boilerplate Instructions

Boilerplate from Nima Boscarino.

In one terminal, run bundle to install the dependencies. Run bin/rake db:setup to create the databases (called rails_project_development by default). Run bin/rails s to run the server.

In the other terminal, cd into client. Run yarn install. Rename the .env.example file to be called .env. Then run yarn start and go to localhost:3000 in your browser.

In the browser, you can click on the button and see the data get loaded.

Next steps

From here, you can start working on your project!

On the Rails side, you may make new resources routes in your routes.rb file, e.g. :

namespace :api do
  resources :dogs # to generate GET /api/dogs, POST /api/dogs, etc...
end

Then you can make your various controllers, models, migrations, etc. as you need! The one funky thing is that instead of rendering an HTML view you'll be rendering JSON. You can return anything from a Rails controller as JSON like this. See the example in my "tests_controller".

On the React side, the important bit is that you make you make your AJAXy HTTP requests using something like axios or superagent. I've set this up to use axios already. Check the React code to see an example request being made on-click to the Rails server! You can make your HTTP requests to /api/anything/you/want, as long as the route exists on your Rails app.

NOTE: I recommend that you namespace all your routes under api on the Rails side! Look at how I've done that in the routes.rb file, and also how the tests_controller is written as:

class Api::TestsController < ApplicationController

and it lives in the api folder! Put all your controllers in there!

Deployment to Heroku

This boilerplate is almost all set up to deal with deploying to Heroku. If you have the Heroku CLI tools installed you can run heroku create to create the Heroku project.

Then we must run two commands to tell Heroku to first build our React app, and then build the Rails app.

  1. heroku buildpacks:add heroku/nodejs --index 1
  2. heroku buildpacks:add heroku/ruby --index 2

Once you've done that, you can run git push heroku master to deploy your project any time you want! Note, however, that deploying to Heroku can be a little slow since Heroku needs to build your React app. Just give it some time.

Once it's deployed, you can run the following commands to manage your app:

  • heroku run rake db:schema:load to set up your database the first time
  • heroku run rake db:migrate for any additional migrations
  • heroku run rake db:seed for seeds
  • heroku run rake db:rollback to rollback a migration

There are other commands, but these are good to get you started!

To make your app work properly with React Router (if you end up using it) on Heroku, I've added a special route to the routes.rb file (get '*path' ... ).