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, Node.js, Docker and make.
The script will do the following among other things:
- Install the dependecies
- Create a docker container for your database
- Prepare your database
- Adds heroku remotes
After the app setup is done you can run it with Heroku Local
$ heroku local
The project is setup to run tests in CircleCI
You can also run the test locally simulating the production environment using docker. Just make sure you have docker installed and run:
bin/cibuild
Style guides are enforced through a CircleCI job with reviewdog as a reporter, using per-project dependencies and style configurations.
Please note that this reviewdog implementation requires a GitHub user token to comment on pull requests. A token can be generated here, and it should have at least the repo
option checked.
The included config.yml
assumes your CircleCI organization has a context named org-global
with the required token under the environment variable REVIEWDOG_GITHUB_API_TOKEN
.
The project comes bundled with configuration files available in this repository.
Linting dependencies like rubocop
or rubocop-rspec
must be locked in your Gemfile
. Similarly, packages like eslint
or eslint-plugin-vue
must be locked in your package.json
.
You can add or modify rules by editing the .rubocop.yml
, .eslintrc.json
or .stylelintrc.json
files.
You can (and should) use linter integrations for your text editor of choice, using the project's configuration.
This projects uses Power-Types to generate Services, Commands, Utils and Values.
For managing tasks in the background, this project uses Sidekiq
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.