https://github.com/vinniciusgomes/idoctor-api
👨🏻⚕️ A system that organizes and streamlines your clinic, has more practicality in your day to day with the software for clinics easier to use.
https://github.com/vinniciusgomes/idoctor-api
airbnb-eslint editorconfig eslint express nodejs prettier typescript
Last synced: about 1 year ago
JSON representation
👨🏻⚕️ A system that organizes and streamlines your clinic, has more practicality in your day to day with the software for clinics easier to use.
- Host: GitHub
- URL: https://github.com/vinniciusgomes/idoctor-api
- Owner: vinniciusgomes
- License: mit
- Created: 2020-08-24T16:29:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-05T03:52:56.000Z (over 5 years ago)
- Last Synced: 2025-03-25T20:06:18.474Z (about 1 year ago)
- Topics: airbnb-eslint, editorconfig, eslint, express, nodejs, prettier, typescript
- Language: TypeScript
- Homepage: https://idoctor-ws.herokuapp.com/
- Size: 253 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚧 WIP API Documentation 🚧
A system that organizes and streamlines your clinic, has more practicality in your day to day with the software for clinics easier to use. We want your clinic to succeed as much as you do!
## :information_source: How To Use
To clone and run this application, you'll need [Git](https://git-scm.com), [Node.js][nodejs] + [Yarn][yarn] installed on your computer.
From your command line:
### Install API
```bash
# Clone this repository
$ git clone https://github.com/vinniciusgomes/idoctor-api
# Go into the repository
$ cd idoctor-api
# Install dependencies
$ yarn install
# Run Migrates
$ yarn typeorm migration:run
# Start server
$ yarn dev
# running on port 3333
```
### Install [FrontEnd](https://github.com/vinniciusgomes/idoctor)
```bash
# Clone this repository
$ git clone https://github.com/vinniciusgomes/idoctor
# Go into the repository
$ cd idoctor
# Install dependencies
$ yarn install
# Run
$ yarn start
# running on port 3000
```
## :rocket: Technologies
This software uses these packages:
- [TypeScript](http://typescriptlang.org/)
- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/pt-br/)
- [bcryptjs](https://github.com/dcodeIO/bcrypt.js)
- [Jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)
- [Multer](https://github.com/expressjs/multer)
- [Postgres](https://www.postgresql.org)
- [Typeorm](https://typeorm.io/#/)
## 🔖 Layout
To access the layout use [AdobeXD](https://xd.adobe.com/view/04daba29-d4ec-4c17-b03f-80bd5df2362c-5189/?fullscreen).
## 🤔 How to contribute
- Make a fork;
- Create a branck with your feature: `git checkout -b my-feature`;
- Commit changes: `git commit -m 'feat: My new feature'`;
- Make a push to your branch: `git push origin my-feature`.
After merging your receipt request to done, you can delete a branch from yours.
## Team
[](https://github.com/vinniciusgomes) | [](https://github.com/felipens/)
---|---
[Vinnicius Gomes ](https://github.com/vinniciusgomes) |[Felipe Novais](https://github.com/felipens)
Front End | Back End
## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/vinniciusgomes/idoctor-api/blob/master/LICENSE) for details.