Skip to content

Manuelp1345/The-Inventorist-Your-Inventory-Hero-BackEnd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The-Inventorist-Your-Inventory-Hero-Back-End

This is the back-end of the The Inventorist app, a simple inventory management system that allows users to keep track of their products and their quantities. The app is built with Node.js, Express, and MariaDB.

How to Run the App

To run the app, follow these steps:

clone the repository

git clone https://github.com/Manuelp1345/The-Inventorist-Your-Inventory-Hero-BackEnd.git
cd the-inventorist-your-inventory-hero-backend

install the dependencies and create the database

npm install
  1. Create a dabaase in MariaDB or mysql.
  2. Create a .env file in the root directory of the project and add the following environment variables:

DB_HOST=localhost
DB_USERNAME=root
DB_PORT=3306
DB_PASSWORD=your_password
DB_DATABASE=your_database_name
JWT_SECRET=your_secret
RESEND_API_KEY=your_resend_api_key
REACT_APP_URL=http://localhost:3000

  1. Run the following commands:
npm run dev

The app will be running at http://localhost:3000.

API Documentation

The API documentation is available at http://localhost:PORT/api-docs.