Skip to content

jonathasgouv/coodesh-backend-challenge

Repository files navigation

Coodesh - Backend Challenge Space Flight News

Version 1.0.0

This is a challenge by Coodesh

Projeto criado para cumprir o desafio de backend da Coodesh. Busquei usar as praticas mais atuais e que garantam a eficiência e escalabilidade. Se você quer construir sua própria versão da API continue lendo, caso contrário leia a documentação integrada na rota "/docs" e aprenda como usá-la.

Conteúdos

Começando

Essas instruções fornecerão uma cópia do projeto instalado e funcionando em sua máquina local para fins de desenvolvimento e teste.

Instalação

Execute os comandos a seguir e você terá uma versão local do projeto em execução.

$ git clone https://github.com/jonathasgouv/coodesh-backend-challenge
$ cd coodesh-backend-challenge/
$ yarn

Renomeie o arquivo .env.example para .env e preencha as variáveis de ambiente. Pronto, agora basta iniciar o server de desenvolvimento com:

$ yarn dev

😀

Para popular a database siga o esquema de quotes disponível na documentação integrada em "/docs".

Instalação com docker

Execute os comandos a seguir e você terá uma versão local do projeto em execução.

$ docker run —name redis -p 6379:6379 -d -t redis:alpine
$ docker run -p 3333:3333 jonathasgouv/coodesh-spaceflightnewsapi          

Pronto, você já tem o projeto rodando. :grinning:

Para popular a database siga o esquema de quotes disponível na documentação integrada em "/docs".

Modo de usar

Confira os endpoints disponíveis na documentação integrada em "/docs".

Apresentação

Uma explicação do projeto em vídeo pode ser vista aqui

Construído com

Autor

Licença

Esse projeto está licenciado sob a licença GPL-3.0 - veja o arquivo LICENSE para mais detalhes.

About

Projeto criado para cumprir o desafio de backend da Coodesh.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published