Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathcale/recruitment-api
https://github.com/mathcale/recruitment-api
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/mathcale/recruitment-api
- Owner: mathcale
- Created: 2022-01-19T02:16:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T22:09:43.000Z (about 2 years ago)
- Last Synced: 2025-02-06T20:45:51.039Z (1 day ago)
- Language: TypeScript
- Homepage:
- Size: 571 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Recruitment API
API para gestão de vagas
## Tecnologias
- Node.js
- Nest.js
- PostgreSQL
## Configuração local
Tenha certeza que o Node.js (>=16.13.2) esteja instalado em sua máquina, caso contrário, instale-o com o utilitário [nvm](https://github.com/nvm-sh/nvm) através do comando `nvm install` na raíz do projeto. Além disso, certifique-se que o Docker está sendo executado para utilizar o banco de dados localmente.
```bash
# Faz o download das dependências do projeto com o Yarn
$ yarn
# Inicializa um container do postgresql em background através do Docker Compose
$ docker-compose up -d
```
## Ao vivo
A aplicação está deployada na Digital Ocean através do serviço App Platform e o banco de dados está no serviço [Supabase](https://supabase.io/).
- Endereço da aplicação: [https://recruitment-api-tiblj.ondigitalocean.app](https://recruitment-api-tiblj.ondigitalocean.app)
## Executando localment
Para interagir com os endpoints disponíveis, utilize a collection disponível em `docs/collections/insomnia-recruitment-api.json` através do programa [Insomnia](https://insomnia.rest/products/insomnia).
```bash
# Inicializa a aplicação em modo de desenvolvimento local com hot reload
$ yarn start:dev
# Inicializa a aplicação em modo de produção (`NODE_ENV === 'production'`)
$ yarn start:prod
```
## Testes
```bash
# Executa todos os casos de teste
$ yarn test
```
## Melhorias
- [ ] Documentação dos endpoints com Swagger/OpenAPI;
- [x] Versionamento dos endpoints;
- [ ] Acertar tipagem/DTO de alguns endpoints;
- [x] Adicionar Github Action para checagem dos testes à cada novo commit;