Este projeto consiste na API criada como parte do processo de contratação da Trybe.

A documentação foi realizada utilizando o Insomnia. Para importar a documentação, com o Insomnia aberto, clique no workspace atual > import/export > import data > from file > e selecione o arquivo trybe-api.json presente na raiz deste projeto.

Caso a importação ocorra com sucesso, seu workspace será alterado para Trybe-BE.

A documentação está presente na aba DOCS de cada requisição. Todos os cabeçalhos foram comentados com explicação do seu significado. Para visualizar os comentários ative a sua exibição. Mais detalhes na sessão Variáveis de ambiente (insomnia) e Informações adicionais da documentação.

Os únicos requisito para o projeto é ter Ruby instalado na máquina, uma vez que este projeto foi desenvolvido utilizando Ruby on Rails e o banco de dados PostgreSQL.

• Ruby 2.6.6p146 (2020-03-31 revision 67876)
• PostgreSQL 12.4
• Rails 6.0.3.4

A maneira mais fácil e recomendada de adquir este projeto é utilizando o git. Para isso, dentro da sua ferramenta de linha de comando, navegue para a pasta onde deseja colocar o projeto e execute: git clone https://github.com/jramiresbrito/trybe-api.git. Caso tenha ssh configurado, o comando é git clone [email protected]:jramiresbrito/trybe-api.git.

Com o projeto baixado, acesse a pasta do projeto cd trybe-api e instale as dependências: bundle install. Caso ocorra um erro, com relação a versão da dependência Sprockets, basta executar o comando: bundle update e, em seguida: bundle install.

O passo final antes de estar pronto para utilização é fornecer as credenciais de acesso ao banco de dados. Essas credenciais devem ser fornecidas através de variáveis de ambiente. As variáveis que devem ser declaradas são:

• TRYBE_API_DATABASE_USER
• TRYBE_API_DATABASE_PASSWORD

Você pode encontrar essas variáveis no arquivo .env.example na raiz do projeto. Para declarar as variáveis, você pode optar por renomear o arquivo .env.example para .env ou criar um novo arquivo chamado .env na raiz do projeto.

Uma vez preenchidas as variáveis estamos prontos para criar o banco de dados.

Um script responsável pela criação dos bancos de desenvolvimento e testes está disponível e deve ser executado com o comando: rails db:create. Se as variáveis de ambiente foram preenchidas corretamente os bancos chamados: trybe_api_development e trybe_api_test serão criados.

Para criar o schema do banco, basta executar o script responsável através do comando: rails db:migrate.

O projeto foi totalmente desenvolvido utilizando TDD. Para rodar a suit de testes execute: bundle exec rspec

Com todos os testes passando, é hora de popular o banco de desenvolvimento: rails db:seed.

Se os passos anteriores foram corretamente executados, está tudo pronto para subir o servidor. Basta executar rails s e aguardar alguns instantes. Com o servidor no ar, a API está disponível no endereço: localhost:3000. Caso você utilize a porta 3000 para outra finalidade, é possível alterar a porta ao subir o servidor: rails s -p NUMERO_DA_PORTA_DESEJADA

A API foi publicada e sua versão em produção está disponível no endereço: http://trybe-api.herokuapp.com/