https://github.com/camilacampos/rails-project-base
Base/Template for a new rails API project configured with docker
https://github.com/camilacampos/rails-project-base
api docker docker-compose postgresql rails ruby ruby-on-rails
Last synced: 6 months ago
JSON representation
Base/Template for a new rails API project configured with docker
- Host: GitHub
- URL: https://github.com/camilacampos/rails-project-base
- Owner: camilacampos
- Created: 2024-03-08T18:16:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T13:46:49.000Z (over 2 years ago)
- Last Synced: 2024-08-23T19:46:13.462Z (almost 2 years ago)
- Topics: api, docker, docker-compose, postgresql, rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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/](http://localhost:7777/)
### Testing and linting
**Tests**
```bash
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**
```bash
make lint # run lint
make lint-fix # run lint and automatically fix issues
```