This is a Rails application, initially generated using Potassium by Platanus.
Assuming you've just cloned the repo, run this script to setup the project in your machine:
$ ./bin/setup
It assumes you have a machine equipped with Ruby, Postgresql, etc. If not, set up your machine with boxen.
The script will do the following among other things:
- Install the dependecies
- Prepare your database
- Adds heroku remotes
After the app setup is done you can run it with Heroku Local
$ heroku local
The style guides are enforced through a self hosted version of Hound CI. The style configuration can also be used locally
in development runing rubocop or just using the rubocop integration for your text editor of choice.
You can add custom rules to this project just adding them to the .ruby-style.yml file.
For defining which parts of the system each user has access to, we have chosen to include the Pundit gem, by Elabs.
For managing tasks in the background, this project uses DelayedJob
We are using the great Devise library by PlataformaTec
For managing uploads, this project uses Paperclip, a gem made by the awesome Thoughbot team.
To schedule recurring work at particular times or dates, this project uses Clockwork
To populate your database with initial data you can add, inside the /db/seeds.rb file, the code to generate only the necessary data to run the application.
If you need to generate data with development purposes, you can customize the lib/fake_data_loader.rb module and then to run the rake load_fake_data task from your terminal.