README.md

Rails Base Project

You can use this project as a quick start for your new Rails project. It was created using Rails 5.1.4 (Ruby 2.4.2), PostgreSQL and RSpec.

It also features the following gems:

• factory_bot_rails
• shoulda_matchers
• rubocop
• simplecov

Setup

To start using this, create a new repository (GitHub, GitLab, etc) and download this base project from here. Extract the downloaded file and rename the folder to your new project name.

Run the following commands inside the root folder to setup your new project:

git init
git remote add origin your-project-git-url
bundle install

Then, run the following command to create your environment variables file:

bundle exec figaro install

Copy and paste the following lines to the generated config/application.yml file:

DATABASE_NAME: your-project-name
DATABASE_USERNAME: your-postgres-username
DATABASE_PASSWORD: your-postgres-password

You can rename the application by changing the config/application.rb file on line 11:

module YourProjectName
...

After this, execute the following step:

rake db:create

Finally, run the application:

rails s

Don't forget to update this README.md to whatever your want before pushing.