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
This project is pre-configured to be (easily) deployed to Heroku servers, but needs you to have the Potassium binary installed. If you don't, then run:
$ gem install potassium
Then, make sure you are logged in to the Heroku account where you want to create the app and run
$ potassium install heroku --force
this will create the app on heroku, create a pipeline and link the app to the pipeline.
You'll still have to manually log in to the heroku dahsboard, go to the new pipeline and 'configure automatic deploys' using Github You can run the following command to open the dashboard in the pipeline page
$ heroku pipelines:open
Remember to connect each stage to the corresponding branch:
- Staging -> Master
- Production -> Production
That's it. You should already have a running app and each time you push to the corresponding branch, the system will (hopefully) update accordingly.
The project is setup to run tests in CircleCI
You can also run the test locally simulating the production environment using CircleCI's method.
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.
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.
For defining which parts of the system each user has access to, we have chosen to include the Pundit gem, by Elabs.
We are using the great Devise library by PlataformaTec
For managing uploads, this project uses Active Storage.
This projects uses Power-Types to generate Services, Commands, Utils and Values.
This project uses Draper to add an object-oriented layer of presentation logic
This projects uses Power API. It's a Rails engine that gathers a set of gems and configurations designed to build incredible REST APIs.
For hot-reloading and fast webpacker compilation you need to run webpack's dev server along with the rails server:
$ ./bin/webpack-dev-server
Running the dev server will also solve problems with the cache not refreshing between changes and provide better error messages if something fails to compile.
For even faster in-place component refreshing (with no page reloads), you can enable Hot Module Reloading in config/webpacker.yml
development:
dev_server:
hmr: true