API REST Hospital Management

Hospital administration. Sign up and register. Patient search, see and add clinical records for doctors. Appointments for patients.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

This project was created for learning to use this technologies.

(back to top)

Built With

• Node.js
• Express.js
• Loki.js
• Faker
• Npmlog
• Swagger autogen
• Jest.js
• Jsonwebtoken

(back to top)

Getting Started

Prerequisites

You will need installed this technologies:

• Node.js v14.x
• Nodemon v2.x
• npm v8.x

Installation

1. Clone the repo

   git clone https://github.com/SusanaSalmeron/hospital_backend

2. Install NPM packages

   npm install

(back to top)

Usage

For using this application, it is mandatory to create a file called .env at root level with the following content:

SECRET_TOKEN="your private key"

With this, the application will be able to generate JWT tokens

Next, in the root directory, you can run:

• To start the project

   npm run dev

• To create the swagger docs

   npm docs

• To start project + swagger

    npm run docdev

• To run test

    npm test

(back to top)

License

Distributed under the MIT License. See license.txt for more information.

(back to top)

Contact

Susana Salmeron - @exdream76 - exdream76@gmail.com

Project Link: https://github.com/SusanaSalmeron/hospital_backend

(back to top)