https://github.com/juuh42dias/transervicos

Nascido na ThoughtWorks Brasil | https://gitlab.com/juuh42dias/transervicos
https://github.com/juuh42dias/transervicos

Last synced: 3 months ago
JSON representation

Nascido na ThoughtWorks Brasil | https://gitlab.com/juuh42dias/transervicos

• Host: GitHub
• URL: https://github.com/juuh42dias/transervicos
• Owner: juuh42dias
• Created: 2019-10-03T22:43:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T15:10:04.000Z (over 1 year ago)
• Last Synced: 2024-01-30T18:28:10.869Z (5 months ago)
• Language: Ruby
• Homepage: http://www.transervicos.org
• Size: 1020 KB
• Stars: 37
• Watchers: 3
• Forks: 16
• Open Issues: 35
• Metadata Files:
  • Readme: README-EN.md

Lists

• awesome-social-projects - Transervicos

README

        
[![Open Source Helpers](https://www.codetriage.com/juuh42dias/transervicos/badges/users.svg)](https://www.codetriage.com/juuh42dias/transervicos)

Version in [PORTUGUESE](https://github.com/juuh42dias/transervicos/blob/master/README.md)

# 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](https://github.com/rbenv/rbenv)  

[PostgreSQL](https://www.digitalocean.com/community/tutorials/how-to-set-up-ruby-on-rails-with-postgres) must be installed and accepting connections.

**Docker and Docker Compose (optional)**

You can use [Docker](https://docs.docker.com/install/) and [Docker

Compose](https://docs.docker.com/compose/install/)

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