Rails Base Project (API only)

This project is meant to be a template for new rails projects (with only api configured). Just clone it or use it as a template to create your new repo.

Setup

System requirements

Dependency	Version
PostgreSQL	13.x
Docker	24.0.6
Docker-compose	2.22.0

Setup project name

Before building and running the application, substitute every change_me or ChangeMe in this project for the new project name.

Running the application

To build the system, run: make build

Make sure the network "change_me" is created: docker network create change_me

To install and/or update dependencies, run: make bundle-install

To run the application, run: make run

To run a terminal attached with debug active (pry), run: make run-debugging

The project will be running on http://localhost:7777/

Testing and linting

Tests

make test # run all tests
make test spec/path_to_spec.rb # run tests of an specific file
make test spec/path_to_spec.rb:34 # run test at an specific line of a file

make test-failures # run only previously failed tests

Lint

make lint # run lint
make lint-fix # run lint and automatically fix issues