rails-template/README.md
2023-02-06 16:52:15 +03:00

39 lines
869 B
Markdown

## DIT RAILS TEMPLATE
This is a template for a Rails project with some default and predefined gems and configurations.
## Instructions
* Clone the repo:
```
git clone git@github.com:ditkrg/rails-template.git
```
```
cd rails-template
```
* create a new rails app with the template flag like below:
```
rails new --api your_app_name -m template.rb
```
**NOTE**
* add .env to .gitignore file
## Arguments
This template by default will create a new rails app with the following:
- postgresql
- rspec
- gemset
- dotenv
- docker
- docker-compose
* if you want to skip any of the above, you can pass the following arguments:
```
- postgres: --skip-postgres
- rspec: --skip-rspec
- gemset: --skip-gemset
- dotenv: --skip-dotenv
- docker: --skip-docker
- docker-compose: --skip-docker-compose
```