Git Product home page Git Product logo

transervicos's Introduction

Open Source Helpers

Version in ENGLISH

Transerviços

Esta é uma aplicação Rails 5.2.x

Documentação

Este README descreve o objetivo deste repositório e como configurar um ambiente de desenvolvimento. Outras fontes de documentação são as seguintes:

Pré requisitos

Este projeto requer:

Ruby 2.6.4, preferencialmente gerenciado usando Rbenv. PostgreSQL deve estar instalado e aceitando conexões.

Docker e Docker Compose (opcionais) Uma alternativa para executar o projeto em modo de desenvolvimento e/ou testes é utilizar o Docker com Docker Compose.

Se você precisar de ajuda para configurar um ambiente de desenvolvimento Ruby, consulte este Guia de instalação do Rails OS X.

Começando sem Docker

bin/setup
Execute o script bin/setup. Este script irá:

  • Verificar se você tem a versão necessária do Ruby
  • Instalar gemas usando o Bundler
  • Criar cópias locais de .env e database.yml
  • Criar, migrar e propagar/popular o banco de dados
  • Executá-lo!
  • Executar o teste bin/rake para garantir que tudo funcione.
  • Executar teste bin/rake: sistema para executar testes do sistema.
  • Execute bin/rails

Começando com Docker

Com Docker e Docker Compose instalados, execute no diretório raíz do projeto:

  • docker-compose build para criar as imagens necessárias
  • docker-compose run web bash para acessar o shell do container já com a aplicação instalada

Dentro desse shell você deve configurar o banco de dados antes de executar outros comandos. Para isso execute:

bin/setup

Para executar a aplicação, a partir do shell do Docker, execute:

rails server -b 0.0.0.0

Executando o projeto de forma local

Para executar o projeto de forma local, após executar o comando bin/setup, basta executar rails server. A aplicação estará disponível no endereço: localhost:3000 em seu navegador.

Caso você esteja utilizando Docker, basta executar docker-compose up. A aplicação estará disponível no endereço: localhost:3000 em seu navegador.

Rodando testes

PENDENTE

transervicos's People

Contributors

auralcat avatar dependabot[bot] avatar joaorsalmeida avatar juuh42dias avatar lunks avatar marceloperini avatar miguelzinhe avatar raphamendonca avatar shadowmaru avatar yemolai avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

transervicos's Issues

[CHORE] - Adjust project documentation

What

It would be nice to have a documentation with more information about:

  • How to set up the local environment
  • How to run local tests, both for the front-end and the back-end
  • A FAQ with common issues when working with the project and how to solve them

Why

The current documentation just lists the DB the project uses, Rails version and tells people to run bin/setup, when we also have a docker-compose build command and we bring up the local server with docker-compose up

What do you think?

[CHORE] - Add a CONTRIBUTING.md file

What

It would be nice to have a CONTRIBUTING.md file for new contributors, with detailed instructions about how to navigate the codebase and run tests, as well as common acceptance criteria for new contributions and how the development process in the project works, once we define one.

Why

This allows people new to the project to "get the lay of the land" and also helps with the exploration of the codebase. For instance, if I'm interested only in the frontend, this file should tell me to look at Vue files, and so on.

Acceptance criteria

  • Instructions about how to set up the local development environment
  • How to run tests
  • Details about the Vue part of the project
  • Instructions explaining how to open a pull request
  • How to open issues

Padronizar o idioma que usamos no projeto

Motivação

Resumindo, eu tô perdida com as linguagens e misturando en_US com pt_BR :S

O que vcs acham? Em uma discussão mais cedo hoje, optamos por manter a comunicação em português. Pra isso, seria bom alterar os templates de issues que colocamos aqui, e até mesmo incluir um template pros PRs.

README with Portuguese and English options

Context

Today the README document of Transerviços only has a Portuguese version. You might want to add another file for an English translation, as commits and PRs (including a PR that adds issue and PRs templates) are in English.

Acceptance Criteria

  • Make sure README document have Portuguese and English versions

Slides of Mitos aren't working

Context

Today the Mitos session is broken slideshow. It doesn't work when clicking the buttons to move from one slide to another. This means not reading the other myths involving transgender people.

Screenshots

Screen Shot 2019-10-05 at 22 46 29

Acceptance Criteria

  • Slides from Mitos section are working
  • Add max-height to .mito

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.