README
How To Run
Ensure foreman
is installed, then:
[PUBLIC_PORT=<port>] foreman start
By default the app will be reachable at localhost:5100
(set by foreman
),
but PUBLIC_PORT
will override this port if set.
Testing
To run tests, ensure that foreman is running using:
foreman start --procfile=Procfile.test
and then run:
rspec
...
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...