diegoma1/mi-recetario

Meal receipts management

Mi Recetario 🍏🧾

Mi Recetario is an app that allows you to store and organize your recipes digitally. Say goodbye to paper-written recipes and have access to your favorite meals anytime, anywhere.

Installation 🚀

To get started, follow these steps:

Clone the repository:

git clone https://github.com/yourusername/mi-recetario.git
cd mi-recetario

Install the necessary dependencies:

npm install

Start the app:

npm start

For Mac users, additionally, you can use Bun as an alternative package manager:

bun install
bun start

Usage 🛒

Create new recipes by adding the required ingredients along with their quantities and steps. View and manage your stored recipes. Utilize the filtering options to quickly find the recipe you're looking for. Use the ingredient matching feature to discover recipes based on the ingredients you have on hand.

Contributing 👥

We welcome contributions! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Submit a pull request with a clear description of your changes.

License 📋

This project is currently not licensed. In the future, we plan to apply the MIT License.

Testing 🔍

For testing purposes, you can use:

bun test

Documentation 📝

Documentation is a work in progress and will be added soon.

Known Issues 🐞

There are currently no known issues. This project is in its early stages.

Roadmap 🗺️

Implement list of meals (add, delete, edit). Add filtering for search purposes. Introduce ingredient matching feature.

Contact Information

Email: [email protected] Discord: diegolas212

Acknowledgements 📲

• Next.js
• Next UI for UI components

Changelog 📃

No changelog available at the moment.