[TESTE] - Teste Técnico - Davi Batista
#30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sobre o projeto
O projeto do back-end foi construído em NestJS + Typescript.
Para iniciar a configuração inicial do sistema, clone o repositório localmente, e depois instale as dependências através do comando
npm i.Após isso, copie os conteúdos do arquivo
./.env.exampleem um novo arquivo chamado.envna root do projeto. Após isso, é preciso preencher as variáveis com as informações de seu banco de dados. A aplicação possui suporte para Postgres e MySQL. Preencha do seguinte modo, substituindo os campos dummy com os dados do seu banco de dados:Após isso, a aplicação necessitará da criação de um banco de dados para funcionar. Já há um script pré-montado para criar o banco no
package.jsonda aplicação. Para rodá-lo, rode o comandonpm run db:create.Após isso, a aplicação está pronta para ser rodada. Rode o comando
npm run start:dev, e ela irá começar a compilar o Typescript e subir a API na porta inserida nas variáveis de ambiente.Documentação da API
A API possui Swagger instalado para a documentação de seus endpoints. Acesse o caminho
localhost:{API_PORT}/swagger, e a documentação da API se tornará visível, com os endpoints mostrando seus possíveis retornos para as requisições:OBS: Devido a uma série de problemas que decorreram nessa semana, não foi possível efetuar a entrega do front-end em conjunto com o back.