Todo: add overview.
You can setup this project on your local machine or a remote server using the following steps.
- Clone the repository from the github project.
- Install the required gems:
bundle install - Create the database and load the seed data (see the Database section for details).
- Run the server:
bin/rails server
This project uses postgresql as the backend database server and relies on some postgresql specific functionality (fuzzystrmatch extension).
After you have cloned the repository to a local directory take a look at config/database.yml to see the default settings. Create a new database with the appropriate name (rol_development by default) and a new super user account (hfh_rol_dev by default). Super user account is needed to enable the fuzzystrmatch postgresql extension.
Once you have created the database and the user, run the following commands to setup the database and load the sample data.
$ rake db:setup
$ rake db:seed
The seed file in the project (not for the tests) includes an initial user admin@example.com with password "password" so you can log in initially. You should disable this user after creating your own.
This project uses the FedEx API to verify addresses. You'll need to obtain a key and set up the following environment variables:
- RAILS_FEDEX_KEY
- RAILS_FEDEX_PASSWORD
- RAILS_FEDEX_ACCOUNT
- RAILS_FEDEX_METER
- RAILS_FEDEX_MODE