The father to every Platanus Rails project
Branch: master
Clone or download
griffero Merge pull request #174 from griffero/fix-database-config-url
fix(config): remove production database url default value
Latest commit b1638eb Nov 22, 2018

README.md

Potassium Circle CI

A Rails application generator from Platanus, inspired by Suspenders.

Installation

You have to install Potassium globally:

$ gem install potassium

Usage

Starting a new project from scratch

Use the potassium create command to create a new project:

$ potassium create <project-name>

It's important to note that it will perform a version check before running to ensure that you're using the latest potassium. Also, if you feel that it's too slow, you may need to update rubygems: gem update --system.

Adding recipes to an existing project

Use the potassium install command to add a recipe to a project:

$ potassium install devise

You can force an already installed recipe by passing the --force argument

$ potassium install devise --force

You can run the command on its own to view all the available recipes and select one:

$ potassium install

What's inside Potassium?

Potassium Rails apps includes the following gems and technologies:

The following optional integrations are added too:

A few more things are added to the project:

  • A low database connection pool limit
  • Setup continuous integration in CircleCI to run tests.
  • Create the github repository for the project (it used hub under the hood)
  • A bin/setup script to setup things on a newly cloned project
  • A bin/cibuild script to run continuous integration build on CI
  • A db:fake_data:load rake task to load fake data for development

API support

The optional API support includes:

Heroku

When you choose to deploy to heroku a few extra things are added for the project.

  • Adds the Rails Stdout Logging gem to configure the app to log to standard out, which is how Heroku's logging works.
  • Adds a Procfile to define the processes to run in heroku
  • Setup continuous integration using docker and herokuish to maintain better parity between testing and production environments
  • Adds a .buildpacks file with the default buildpacks to use. It use the following buildpacks:
index buildpack description
1. nodejs to support javascript package management with yarn and webpack based asset compiling
2. ruby-version to support the use of .ruby-version file to instruct heroku which ruby version to use
3. ruby the base buildpack to run ruby applications
4. ruby-deploy-tasks to run rake task after the deployment is complete, for example db:migrate

Also the heroku applications are created

  • Creates a staging and production applications
  • Creates a pipeline and assign the above application to the staging and production stages.
  • Setup initial configuration variables
  • Set the application buildpack to the multi-buildpack
  • Set deploy-tasks buildpack is setup to run rake db:migrate after each deploy

You'll need to manually

  • Connect the pipeline with the github repository
  • Assign a branch to each stage for auto deployments
  • Enable deploy after CI pass

Continuous Integration

In order to CicleCI start building the project on each push you need tell circle ci. Go to https://circleci.com/add-projects, choose the repository from the list and hit Build Project

Hound CI

In order to Hound start checking your project's PRs you need enable that repository. Go to https://monkeyci.platan.us, choose the repository from the list and hit Activate

Development Tools

Creating a new Test project from scratch

This is useful when you are adding new recipes to Potassium, and you want to use the potassium create command, to check the new functionality without pain. To achieve this you need to run, In the Potassium's root path, the bin/potassium_test create instead of potassium create command. This command, will do the same as potassium create but first:

  • Will drop any existent database of the test app.
  • Will remove the directory containing a previous version of the test app.

It's important to remember that bin/potassium_test create:

  • Does not receive an app_path param. It always creates the test project inside /tmp/dummy_app
  • Can receive the same options as potassium create.
  • Runs with options with a default value. This is to avoid the "asking part" of the creation process. You need to enable what you want to test like this: $ bin/potassium_test create --clockwork

Contributing

If you want to add functionality please go to the contributing

Credits

Thank you contributors!

Platanus

potassium is maintained by platanus.

License

Potassium is © 2014 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.