Thanks to visit codestin.com
Credit goes to github.com

Skip to content

This project consists of a REST API developed to simulate operations in a medical office, such as account creation, listing, updating, and much more. The goal is to provide a foundation for building a system following REST standards, using TypeScript, Prisma, PostgreSQL, and Jest for testing.

License

Notifications You must be signed in to change notification settings

polianams/api-clinic

Repository files navigation

💊 Back-end - API REST de um Consultório com Prisma, PostgreSQL e Typescript

GitHub language count Repository size GitHub last commit

Feito por Poliana Santos

Stargazers

🚧 API REST de um Consultório com Prisma, PostgreSQL e Typescript 🚧

Status Concluído

📝 Sobre o Projeto

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.

📋 Funcionalidades

Até o momento, é possível realizar as seguintes operações:

  • Listar especialidades que a clínica oferece;
  • Login administrativo;

🎯 Testes com Jest

  • Os testes realizados nessa aplicação foram feitos utilizando o Jest.

📖 Documentação com Swagger

  • Em breve.

▶️ Como Executar o Projeto

🛠️ Pré-requisitos

  • 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.

⚙️ Instalação

  1. Clone este repositório em sua máquina local:
git clone https://github.com/seu_usuario/api-clinic.git
  1. Navegue até o diretório do projeto:
cd api-clinic
  1. Instale as dependências:
npm install
  1. Execute o servidor:
npm run start

ou, se preferir

npm run dev

🚀 Tecnologias Utilizadas

Dependências de Desenvolvimento:

🤝 Contribuição

Contribuições são bem-vindas! Para contribuir com o projeto, siga as etapas abaixo:

  1. Faça um fork deste repositório;
  2. Crie uma branch com sua feature:
git checkout -b minha-feature
  1. Faça commit das suas alterações:
git commit -m 'Minha nova feature'
  1. Faça push para a branch:
git push origin minha-feature
  1. Abra um pull request.

🧙‍♂️ Autora

Este projeto foi desenvolvido por Poliana Santos.

📝 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

About

This project consists of a REST API developed to simulate operations in a medical office, such as account creation, listing, updating, and much more. The goal is to provide a foundation for building a system following REST standards, using TypeScript, Prisma, PostgreSQL, and Jest for testing.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published