Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.64 KB

rails_engine_development.md

File metadata and controls

56 lines (37 loc) · 1.64 KB
Raw

Rails Engine Development

Installing Dependencies

Ensure the development machine meets the requirements listed in the readme. From the repository root run:

$ bundle install
$ yarn install

Build node packages to assets directory:

$ bin/build-packages

Running the Test Suite

Pageflow expects credentials of a MySQL user in the environment variables $PAGEFLOW_DB_USER AND PAGEFLOW_DB_PASSWORD. By default "root" and the empty password are used. If your MySQL is on a different host, you can specify a MySQL host in the environment variable $PAGEFLOW_DB_HOST and a port in $PAGEFLOW_DB_PORT (default: 3306).

Use the binstub to invoke the Ruby test suite

$ bin/rspec

Chrome 59 or newer has to be installed on the same computer you're running the tests on.

The dummy Rails app used for tests is created automatically through the install generator during test runs. To have it regenerated, simply delete the contents of the spec/dummy directory. This is required everytime new migrations are added or if tests are failing after pulling changes into the local working tree.

Troubleshooting

If after updating your local branch specs start failing, there are two things you could try:

  • Check whether there are files in the Git working directory that are newly untracked. If this is the case, delete them;
  • also, you can try running yarn install --force and then bin/build-packages again.

Developer console

An IRb console is available with all Pageflow classes loaded. You can use this to try out any code you've touched.

$ bin/console

See Also