Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrekuratomi/kenziedoc
https://github.com/andrekuratomi/kenziedoc
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/andrekuratomi/kenziedoc
- Owner: AndreKuratomi
- Created: 2022-03-13T01:11:29.000Z (almost 3 years ago)
- Default Branch: configPdf
- Last Pushed: 2023-09-19T15:11:04.000Z (over 1 year ago)
- Last Synced: 2023-09-19T17:16:37.541Z (over 1 year ago)
- Language: TypeScript
- Size: 733 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## KENZIEDOC
- [Sobre](#sobre)
- [Instalação](#instalação)
- [Documentação](#documentação)
- [Desenvolvedores da API](#desenvolvedores-da-api)
- [Termos de uso](#termos-de-uso)
# Sobre
A aplicação KenzieDoc se propõe a cadastrar médicos e pacientes na plataforma possibilitando o agendamento de consultas de maneira simples e intuitiva, além de fazer a gestão de consultas agendadas e a da lista de espera.
O objetivo da aplicação é ser uma ferramenta que possibilite o profissional de saúde cadastrar sua especialidade e seus locais de atendimento e possibilitar ao paciente fazer uma busca pelo profissional mais adequado para sua necessidade e agendar a consulta de forma confortável, prática e rápida.
Esta API utiliza o ambiente de desenvolvimento Node.js e o framework Express.js
Frontend repository: https://github.com/AndreKuratomi/Capstone-Q4-Frontend
# Instalação
0. Primeiramente, é necessário já ter instalado na própria máquina:
- Um editor de código, conhecido também como IDE. Por exemplo, o [Visual Studio Code (VSCode)](https://code.visualstudio.com/).
- Uma ferramenta cliente de API REST. Por exemplo, o [Insomnia](https://insomnia.rest/download) ou o [Postman](https://www.postman.com/product/rest-client/).
-
E versionar o diretório para receber o clone da aplicação:
```
git init
```
1. Fazer o clone do reposítório Users service na sua máquina pelo terminal do computador ou pelo do IDE:
```
https://github.com/AndreKuratomi/KenzieDoc.git
```
Entrar na pasta criada:
```
cd KenzieDoc
```
Instalar as dependências:
```
yarn
```
Obs: caso não tenha o gerenciador de pacotes yarn instalar desta maneira:
```
npm install --global yarn
```
E rodar a aplicação:
```
code .
```
Após feito o clone do repositório KenzieDoc, instalar :
1. O arquivo oculto .env com o comando:
```
touch .env
```
E dentro do arquivo .env configurar os seguintes comandos:
```
POSTGRES_PASSWORD=digite_sua_senha
POSTGRES_USER=digite_seu_usuário
POSTGRES_DB=digite_seu_banco_de_dados
POSTGRES_HOST=digite_seu_localhost
SECRET=digite_sua_chave_de_segurança
```
# Documentação
Para ter acesso ao descrições detalhes das rotas e seus retornos, conferir documentação completa no link a seguir:
https://kenziedoc-omega.vercel.app/
# Desenvolvedores da API
André Kuratomi
David Avanci
Keila Passos
Leonardo Pereira
Pierre Kalil
# Termos de uso
Esse projeto atende a fins exclusivamente didáticos e sem nenhum intuito comercial.