APP FOOD-TRACKER

This app was built with the hope of helping the 'Amigos de la Calle' association manage their product inventory as they carry out their vital work supporting those most in need.

---

🚀 Backend Guide

Follow these steps to set up the backend:

Pre-requisites

• Node.js version 18 or higher
• MySQL
• npm or pnpm for package management

Installation

Clone the repository and navigate to the backend folder:

git clone [https://github.com/sargentogato/App-Food-Tracker.git](https://github.com/sargentogato/App-Food-Tracker.git)
cd App-Food-Tracker/backend
npm install

Environment Variables

Create a .env file in the backend root directory and use .env.example as a template.

cp .env.example .env

💡 Open .env file and configure credentials with your own data.

Execute

npm run start:dev

The API will be available at http://localhost:5000/api/v1

Testing

To execute unit tests, run:

npm run test

🛠️ Stack

• Framework: NestJS
• ORM: TypeORM
• Database: MySQL
• Documentation: Swagger
• Testing: Jest
• Authentication: Passport JWT
• Validation: class-validator
• Encryption: bcrypt

🏗️ Project Architecture

The project follows a Modular Architecture, separating logic by domains (Items, Products, Users, Providers...). Each module encapsulates its own controllers, services, and entities, ensuring maintainable code that is easy to scale.

---

🚀 Frontend Guide

🚧 Under construction

---

Team

• Marlon
• J Ramón Carralero
• Manuel Tomasino
• Marta Vilaseca
• Raúl Gambalonga