Skip to content

README.md

Latest commit

 

History

History
69 lines (43 loc) · 2.1 KB

README.md

File metadata and controls

69 lines (43 loc) · 2.1 KB

Motion Hub API 🎬

It's a simple API where you can store the details of your videos, like title, description and duration.
It uses in-memory database. It means it will only store data while running and when you stop the application all data will be lost.

Docs 📋

You can check the API Documentation while running the application on

http://localhost:3333/documentation

Or enter the swagger.yaml in the SwaggerEditor

Test Plan 👨‍🔬

The avaiable Test Plans for the application are located here:
🎬 Motion Hub API Testing Plans

Postman Collection:
Run In Postman

Installation 🏗️

To run this project you will need

  • Node.js (I've used version v18.17.1 while writing this doc)

Note: When installing Node.js, npm is automatically installed. 🚀

Run to install the dev dependencies

npm install

Start the API with the command

npm run start

Running the tests ✔️

In this project, you can run tests in interactive and headless mode

Headless mode </>

Run npm test (or npm t for short) to run all tests in headless mode.

npm test

Interactive mode 🕹️

Run npm run cy:open to open the Cypress App to run tests in interactive mode.

npm run cy:open

Support this project 🙌

If you want to support this project, leave a ⭐.

Made with love 🧡 by Rodrigo Molter