/bank_app

Primary LanguageRuby

Bank App

Quick start

  1. Install Docker & Docker Compose

  2. Install Yarn or NPM

  3. Make sure backend/config/master.key is in place (otherwise you may need to re-generate credentials)

  4. Run docker-compose build

  5. Run docker-compose up

Tests

docker-compose run backend rspec

Linters

docker-compose run backend rubocop

Generate API docs

docker-compose up backend -d || (dcup backend -d)
docker-compose exec backend rake docs:generate || (dce backend rake docs:generate)

http://localhost:3000/api/docs

Test users

Test users can be found in the seed.rb file.

backend/db/seeds.rb

Links

Name Link
API http://localhost:3000
Client http://localhost:8080
API docs http://localhost:3000/api/docs

Commands (docker-compose)

Command Alias Description
docker-compose up dcup starts dev environment (all services)
docker-compose stop dcstop stops dev environment (all services)
docker-compose up backend dcup backend starts backend (API) only
docker-compose up backend client dcup backend client starts both backend & client
docker-compose ps dcps shows status of running containers
docker-compose exec backend bash dce backend bash opens terminal inside container
docker-compose exec backend rails c dce backend rails c opens rails console inside container
docker-compose exec backend rubocop dce backend rubocop runs rubocop in backend container (you can use -a option to fix issues automatically)
docker-compose exec backend {command} dce backend {command} to run any command inside a particular container
docker-compose run backend {command} dcr backend {command} to run any command inside a particular container and to start container automatically
  • to use aliases nano ~/.zshrc and add plugins=(docker-compose ...)