https://github.com/gabriel4420/backend_winmed_challenge

API para o sistema medico de cadastro de medicos e clinicas, relacionada ao desafio da empresa winmed.
https://github.com/gabriel4420/backend_winmed_challenge

abstraction api-rest backend deployment heroku nodejs

Last synced: 16 days ago
JSON representation

API para o sistema medico de cadastro de medicos e clinicas, relacionada ao desafio da empresa winmed.

• Host: GitHub
• URL: https://github.com/gabriel4420/backend_winmed_challenge
• Owner: Gabriel4420
• Created: 2022-01-09T22:08:18.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T04:57:08.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T04:13:10.677Z (almost 2 years ago)
• Topics: abstraction, api-rest, backend, deployment, heroku, nodejs
• Language: JavaScript
• Homepage: https://winmed-challenge.herokuapp.com/hello
• Size: 5.66 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        


   

  

  

  


  

  

    

  

  

  

  

    

  



 📖 DOCUMENTAÇÃO 📖


API para o sistema medico de cadastro de medicos e clinicas, relacionada ao desafio da empresa winmed.

Logo abaixo, segue as rotas da api que funcionam

 ⚠️ IMPORTANTE ⚠️ 


É importante gerar um token e se autenticar para poder usar as rotas abaixo:

POST >> /login >> JSON-BODY

| Verb   | Action        | url                  |

| ------ | ------------- | -------------------- |

| GET    | Get Users     | '/users'             |

| GET    | Get User      | '/user/:id'          |

| GET    | Get Doctors   | '/doctors'           |

| GET    | Get Doctor    | '/doctor/:id'        |

| GET    | Get Clinics   | '/clinics'           |

| GET    | Get Clinic    | '/clinic/:id'        |

| POST   | Add User      | '/users'             |

| POST   | Add Clinic    | '/register/clinic'   |

| POST   | Add Doctor    | '/register/doctor'   |

| PATCH  | Update Clinic | '/update_clinic/:id' |

| PATCH  | Update Doctor | '/update_doctor/:id' |

| DELETE | Delete Clinic | '/delete_clinic/:id' |

| DELETE | Delete Doctor | '/delete_doctor/:id' |

## 👨‍💻️ Tecnogias utilizadas

O projeto foi desenvolvido utilizando a seguinte tecnologia:

- [NodeJS](https://node.com.br)

### Padronização de código

- [Prettier](https://prettier.io/)

### IDE

- [Visual Studio Code](https://code.visualstudio.com/)

## 📦️ Como utilizar o projeto

Para copiar o projeto, utilize os comandos:

```bash

  # Clonar o repositório

  ❯ git clone https://github.com/Gabriel4420/backend_winmed_challenge.git

```

Para instalar as dependências e iniciar o projeto, você pode utilizar o yarn ou npm:

**Utilizando yarn**

```bash

  # verificar as dependências

  ❯ yarn

  # rodar projeto

  ❯ yarn dev

```

**Utilizando npm**

```bash

  # Atualizar as dependências

  ❯ npm install

  # Iniciar o projeto

  ❯ npm dev

```



  Feito com ❤️ por Gabriel Rodrigues 👋️ Entre em contato!