Skip to content

Latest commit

 

History

History
108 lines (69 loc) · 3.07 KB

README.md

File metadata and controls

108 lines (69 loc) · 3.07 KB
Raw

The Rules

  • You must use Rails 5+ as it uses the --api flag
  • You must have create-react-app installed globally
  • If things are broken first check to make sure dependencies are up to date
  • Pull requests are welcome

Usage

  • create-repack-app name_of_app
  • You will be asked if you have create-react-app installed globally.
    • If you say yes and you don't it will break
    • If you say no the program will exit
  • You will be asked what port you want to run your rails server on. The default is 3001. I reccomend not using 3000 as this is the default port for create-react-app and it is easier to change the rails port.
  • If you change your rails port in the future you will need to update the proxy in client/package.json
  • The rails app is located in the root and the react app is located in /client

Options

--full

IMPORTANT: When using the full flag you must be on v 3.1.0 or higher due to changes in create-react-app 2.0.0

You also have the option to add --full flag, this is going to add Devise to Rails, and add React-Router, Redux, Semantic-UI to React (/client)

This flag includes a basic component set up for authentication with a nav bar, register page and login page.

Reusable components

You will find some reusable components in client/components

  • ProtectedRoute

    ProtectedRoute will allow you to redirect unauthorized users to the login page.

    If the users are logged in, will redirect them to the Hello example

    <ProtectedRoute exact path='/hello' component={Hello} />

  • AuthRoute

    AuthRoute are used to prevent the authorized users hit the login or register route again if the are already logged.

    If the users are logged in, will redirect them to the homepage.

    <AuthRoute exact path='/register' component={Register} />

-y

For frequent users, this will skip all setup questions and default rails port to 3001

Deploy

If you are deploying to heroku you will need to update the buildpacks: NOTE: The order does matter.

heroku buildpacks:clear
heroku buildpacks:set heroku/nodejs
heroku buildpacks:add heroku/ruby --index 2

All you have to do now is push to heroku.

If you are deploying anywhere else you will need to run the following scripts in the root as part of your deploy process:

yarn build
yarn deploy

Or if you prefer:

npm run build
npm run deploy

Truth

This package is not complicated. It is really just a cli that runs other cli's.

First it installs rails.

Then it copies over a prefilled out config/routes and app/controllers/static_controller.rb as well as a package.json.

Then it installs create-react-app to the client/ folder.

Finally it adds a proxy to client/package.json

Oh yeah and the name is totally ripped off

Known issues

If Nokogiri updates this CLI will fail. The reason why is because it times out on the bundle install and moves on to the next command. To fix this you can do the following:

  1. cd app/you/created
  2. bundle
  3. cd ..
  4. rm -rf app/you/created
  5. create-repack-app app/you/created

I am looking into many solutions and I am open to ideas.