BaseSource

Requirements
Initialization
Setup
Deployment
Supplement

Requirements

Docker 19.x

If you run the project locally, the followings are required.

Ruby 3.0.0
Bundler 2.1.x
Node.js 14.15.1
Yarn 1.22.x
Postgres 14.x

Setup

Setup procedure of development environment.

Run cp .env.example .env and open .env file to edit environment variables.

Docker environment

Build docker containers

docker-compose build

Setup database Development

docker-compose run web bundle exec rake db:create db:migrate db:seed

After running seed, there should be a doorkeeper application record in your database. In your rails console, run the following command:

Doorkeeper::Application.last

Copy uid and secret and put them in NextJS project's .env file under corresponding env variables: NEXT_APP_CLIENT_ID and NEXT_APP_CLIENT_SECRET

Setup database Test

docker-compose run web bundle exec rake db:create db:migrate db:seed RAILS_ENV=test

Rswag

docker-compose run web  bundle exec rake rswag:specs:swaggerize

Start the app

docker-compose up

Local environment without Docker

If you want to use Rails without Docker, then follow below steps

Install dependencies

bundle install

Start postgres and setup database

bin/rake db:create db:migrate db:seed

Start the app

## API server
bin/rails s

Start console

bin/rails c

Mail server in development environment

If you install and run rails server on your local machine, email will be open immediately on your browser when an email is sent by rails. If you're using docker, please go to mailbox at http://localhost:1080

Deployment

Once you created the staging and production environments in Jitera's DevOps menu, you can deploy to staging by pushing a new commit to develop branch, and to production by pushing a new commit to master branch.

DB Dump from Server to local

Please read notion for DB dump steps

Supplement

This project was generated by jitera automation, run by Jitera.

nao215/D20240111D