Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaoemanuell/shopper-nestjs-technical-test
Api for shopper node technical test
https://github.com/joaoemanuell/shopper-nestjs-technical-test
api backend docker docker-compose gemini ia nest nestjs node nodejs openapi sqlite swagger
Last synced: 3 months ago
JSON representation
Api for shopper node technical test
- Host: GitHub
- URL: https://github.com/joaoemanuell/shopper-nestjs-technical-test
- Owner: JoaoEmanuell
- License: mit
- Created: 2024-08-27T12:22:37.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-30T14:50:05.000Z (4 months ago)
- Last Synced: 2024-10-11T05:03:01.732Z (3 months ago)
- Topics: api, backend, docker, docker-compose, gemini, ia, nest, nestjs, node, nodejs, openapi, sqlite, swagger
- Language: TypeScript
- Homepage:
- Size: 465 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-pt_br.md
- License: LICENSE
Awesome Lists containing this project
README
- [Shopper Node Technical Test](#shopper-node-technical-test)
- [Começando](#começando)
- [Dependências](#dependências)
- [Docker](#docker)
- [Node](#node)
- [Testes](#testes)
- [Documentação](#documentação)
# Shopper Node Technical Test
Teste técnico para a vaga de Desenvolvedor Web Full-Stack Júnior.
## Começando
Crie um arquivo `.env` na raiz do repositório
Preencha o arquivo com uma [chave de api do Gemini](https://ai.google.dev/gemini-api/docs/api-key).
```
GEMINI_API_KEY= api key for gemini
```
### Dependências
```
node >= 20.17.0
docker => 24.0.7
Docker Compose => 2.24.6
```
### Docker
Faça a build do projeto por meio do `docker compose`
```
docker compose build
```
Suba o projeto (Você também pode executar apenas essa etapa e o projeto já estará no ar)
```
docker compose up
```
Ele estará disponível na porta **8080**
### Node
Acesse o diretório `shopper-node-technical-test`
```
cd shopper-node-technical-test
```
Faça a instalação das dependências.
```
npm install -y
```
Execute o setup
```
node setup.mjs
```
Execute as migrations
```
npm run migration:run
```
Faça a build
```
npm run build
```
Execute o projeto
```
npm run start:prod
```
## Testes
Acesse o diretório `shopper-node-technical-test`
Execute os testes
```
npm run test
```
# Documentação
Para acessar a documentação, execute o container e acesse a rota `docs` ou veja a especificação da [openapi](./docs/openapi.yaml)