O projeto consiste na criação de uma API REST utilizando Node.js, Express, TypeScript, Prisma e PostGreSQL como banco de dados, visando simular o funcionamento do backend de um consultório/clinica. O objetivo inicial da API é permitir o login administrativo, cadastro de pacientes e consultas e obtenção de laudos. Ao longo do tempo, outras funcionalidades serão implementadas.
Até o momento, é possível realizar as seguintes operações:
- Listar especialidades que a clínica oferece;
- Login administrativo;
- Os testes realizados nessa aplicação foram feitos utilizando o Jest.
- Em breve.
- Possuir um editor de código-fonte, por exemplo VSCode ou Vim;
- Possuir o Git ou qualquer outro programa de versionamento;
- Possuir o Node.js (versão 18.16.0 ou superior);
- Possuir o Insomnia instalado.
- Clone este repositório em sua máquina local:
git clone https://github.com/seu_usuario/api-clinic.git
- Navegue até o diretório do projeto:
cd api-clinic
- Instale as dependências:
npm install
- Execute o servidor:
npm run start
ou, se preferir
npm run dev
- Node.js (versão 18.16.0);
- Typescript (versão 5.2.2);
- Express.js (versão 4.18.2);
- PostgreSQL com a biblioteca pg (versão 8.11.3);
- jsonwebtoken (versão 9.0.2);
- ts-node-dev (versão 2.0.0);
- nodemon (versão 3.0.1);
- @types/express (versão 4.17.20);
- @types/uuid (versão 9.0.6).
- Jest (versão 29.7.0);
Contribuições são bem-vindas! Para contribuir com o projeto, siga as etapas abaixo:
- Faça um fork deste repositório;
- Crie uma branch com sua feature:
git checkout -b minha-feature
- Faça commit das suas alterações:
git commit -m 'Minha nova feature'
- Faça push para a branch:
git push origin minha-feature
- Abra um pull request.
Este projeto foi desenvolvido por Poliana Santos.
Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.