https://github.com/yeukfei02/news-api

grape postgres rails rspec ruby ruby-on-rails

Last synced: about 2 months ago
JSON representation

news-api

README

# news-api

news-api

documentation:

## Requirement

- install ruby (v3.0.3)
- install gem
- install bundle

## Testing and run

```zsh
// install ruby dependencies
$ bundle install

// run api in local
$ rails s

// create controller
$ rails g controller

// create model
$ rails g model

// create migration file
$ rails g migration

// db migration
$ rails db:migrate

// db rollback
$ rails db:rollback

// db reset
$ rails db:migrate:reset

// list routes
$ rails routes

// run test case
$ bundle exec rspec

// rubocop
$ rubocop --auto-correct
$ rubocop -A

// reek
$ reek

// generate schema info in model
$ annotate --models

// audit Gemfile.lock
$ bundler-audit
```

## Docker

```zsh
// build images and start container in one line
docker-compose up -d --build

// run db migration in container
docker-compose exec web bundle exec rails db:migrate

// go inside container
docker exec -it /bin/bash

// check container logs
docker logs

// remove and stop container
docker-compose down
```

open localhost:3000