Ensure the development machine meets the requirements listed in the readme. From the repository root run:
$ gem install bundler
$ bundle install
$ bin/npm install
Build node package to assets directory:
$ bin/npm run build
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 binstubs to invoke the Ruby test suite
$ bin/rspec
or the headless browser based Javascript test suite
$ bin/teaspoon
PhantomJS has to be installed on the system.
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.
An IRb console is available with all Pageflow classes loaded. You can use this to try out any code you've touched.
$ bin/console