Dashboard API
API application for managing data from the mobile web application and the Vibra management panel.
Technologies
Preview
========================================================================
Other settings in the project
| Tsconfig | Prettier | Jsonwebtoken |
| Eslint | Ejs | Cron |
| Git | log4js | moment |
| Pre-commit | NestJS | MongoDb |
| Mongoose | socket-io | Typescript |
Starting 🚀
These instructions will allow you to get a copy of the project running on the local machine for development and testing purposes.
See Deployment to learn how to deploy the project.
Pre- requirements 📋
- NodeJS current version v20.13.1
- MongoDB
Recommended 📋
- MongoDB Compass
- Warm
- Trae
- Postman
- GitHub Desktop
- Android Studio Emulator Device
Installation 🔧
To install the project locally and run the api please execute the following steps
Clone the vibra-api repository from github
git clone https://github.com/Guarnizo2023/vibra-api.git
Install the dependencies
npm i
Set configuration .env
Set your environment variables in the .env file
Compile the project and start the server
npm run start-env
Invoke the service status endpoint
http://localhost:4000
Swagger 📦
Invoke the API documentation endpoint
http://localhost:4000/api
Deployment 📦
Compile the project and build the application sources
npm run compile
Built with 🛠️
Tools and Technologies used
- NodeJS - Server-side JavaScript environment,uses an asynchronous and event-driven model
- NestJS - Fast, unopinionated, minimalist web framework
- Npm - Dependency manager
- MongoDB - Database engine
- Mongoose - Lib Query MongoDB
- Swagger -Swagger is an open specification for defining APIs
Contributing 🖇️
Contributions are currently not allowed.
Versioned 📌
SemVer is used for versioning. For all versions available.
Authors ✒️
Built by
- Ermes Guarnizo Motta - Engineer System Teacher UNAD - Guarnizo2023
- Yovany Suárez Silva - Full Stack Software Engineer - desobsesor
License 📄
This project is under the MIT License - see the file LICENSE.md for details
Expressions of Gratitude 🎁
⌨️ With ❤️ for the educational community.