FIRST PLUG

See the frontend repository - Client »

Table of contents

1. About the Project
2. Built With
3. Getting Started
   • Installation
4. Contributing
   • Report Bug - Request feature
   • Pull Request
5. Contact

1. About the Project

Website where the main focus is inventory management, acquisition and control. in order to simplify onboarding and equipment for remote workers.

⬆ Back to top

2. Built With

In the table below, you can see the complete list of the various technologies and libraries that we have used for the development and creation of this project.

NodeJS	MongoDB	NestJS
Express	Mongoose	JWT

⬆ Back to top

3. Getting Started

This project is not yet deployed, but you can try it in your local. Follow the instructions below to run it.

💠 INSTALLATION

1. Clone the repository

   git clone https://github.com/RafaMojica/First-Plug-Platform-Api.git

2. Install YARN dependencies

   yarn install

3. Create a file in the root .env.local then use the .env.example file found in this repository as a base

   PORT=3001
   DB_CONNECTION_STRING=
   JWTSECRETKEY=
   JWTREFRESHTOKENKEY=

4. Run the server

   npm server

⬆ Back to top

💡 PULL REQUEST

1. FORK to the project.
2. Create your Feature Branch (git checkout -b feature/MyFeature)
3. Commit your Changes (git commit -m 'Add MyFeature')
4. Push to the Branch (git push origin feature/MyFeature)
5. Open a Pull Request

⬆ Back to top

5. Contact

Francisco Villanueva: Developer

Esteban Nahuel Rodríguez: Developer

⬆ Back to top