README.md

Fitness Foot API 🥦🏋️‍♂️

This is a challenge by Coodesh 🚀

Description

The Fitness Foot API provides details about fitness food products. Every day at midnight, a cron job runs to import updates of products from Open Food Facts. 📆🛒

🛠️ Stacks

• NestJS
• TypeScript
• Jest
• Prisma
• PostgreSQL
• Docker

⚙️ How to Install

To install and set up the API, follow these steps:

1. Set up the environment variables by creating a .env file in the root directory. You can refer to the .env.example file for the required variables.
2. Run the Docker containers using the command docker compose up -d. 🐳

How to Use 🚀

To use the API, follow these steps:

1. Access the API documentation by visiting http://localhost:3000/api to explore the available routes and their details. 📚🔍
2. For private routes, you need to include the x-api-key header in your requests. Make sure to pass the API key to access the protected routes. 🔒