Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.92 KB

README-EN.md

File metadata and controls

61 lines (38 loc) · 1.92 KB
Raw

Open Source Helpers

Version in PORTUGUESE

Transerviços

This is a Rails 5.2.x application.

Documentation

This README describes the goal of this repository and how to configure the development environment. There are also other documentation sources as follow:

Pre conditions:

Requirements:

Ruby 2.6.4, preferably managed using Rbenv
PostgreSQL must be installed and accepting connections.

Docker and Docker Compose (optional)

You can use Docker and Docker Compose to run this project on development or test mode.

If you need help to configure the Ruby development environment, consult this Rails OS X installation guide.

Getting Started without Docker

bin/setup
Execute the bin/setup script. This script will:

  • Verify if the necessary Ruby version is installed
  • Install the gems using Bundler
  • Create local copies of .env and database.yml
  • Create, migrate and populate the database
  • Run!
  • Run the bin/rake test to guarantee that everything is working fine.
  • Run bin/rake test:system to execute every system tests.
  • Run bin/rails

Gettint Started with Docker

After you have installed Docker and Docker Compose, run the commands below:

  • docker-compose build to create the Docker Images
  • docker-compose run web bash to open a shell inside the container with the application already setup

Within this shell you must setup the application database before running other commands. To do so, run: bin/setup

To run the application, run:

rails server -b 0.0.0.0

Testing

PENDING