miRent - Api Rest

                                                

Repositorio   |   Deploy   |   Frontend

Requirements

As minimum requirements you need to have installed:

• node.js version 16.13.0 or higher.
• npm version 8.1.4 or higher.

Set environment variables:

• Create a file called dev.env
• Use reference

Project Installation:

1. Download the project by opening the terminal and executing the following command:

   git clone https://github.com/luisangelsalcedo/mirent-api.git
   

2. Get into the project directory by executing the following command:

   cd mirent-api
   

3. Install all dependencies by executing the following command:

   npm install
   

4. Run the application by executing the following command:

   npm run dev
   

5. Open the following URL http://localhost:5000 in your browser.

   If you have any questions, contact us

Documentation

You can find all the functionalities of the api documented in the following link: miRent api documentation

Run tests

Set environment variables for tests:

• Create a file called test.env
• Use reference

Run the application in the test environment:

• Running the command: npm run dev-test to start the application in the test environment.
• Open another terminal
• Running the command: npm run test to run all the tests.