Skip to content

OptimumAF/My-Recipes

Repository files navigation

My Recipes 🍴

Welcome to the My Recipes repository! This collection features a curated list of recipes ranging from main courses and side dishes to desserts and appetizers. The goal is to share and collaboratively expand a library of delicious recipes for everyone to enjoy.


Table of Contents


About

This repository contains a variety of recipes formatted for easy reading and consistent organization. Each recipe includes categories, cooking times, and serving sizes, along with detailed instructions and ingredient lists.

You can browse the existing recipes or contribute your own by following the guidelines below.


App (PWA)

This repo includes a small offline-friendly web app that reads the markdown recipes in Recipes/. It can be installed to a phone home screen from the browser menu.

Local development

npm install
npm run dev

Build

npm run build

GitHub Pages

The workflow in .github/workflows/deploy.yml builds and deploys to GitHub Pages. It sets BASE_PATH automatically so the app works from a repo subpath.


Recipes

Explore the popular recipes:

  1. Hamburger Tacos
  2. Ramen
  3. Pico de Gallo
  4. Mashed Potatoes

More Recipes


Contributing

We welcome contributions! Whether you have a family favorite or an innovative new recipe, feel free to share it with the community.

Recipe Template

Please use the following template to format your recipes:

# Recipe Name

**Category**: [e.g., Main Course, Side Dish, Dessert, etc.]  
**Cooking Time**: [e.g., 30 minutes]  
**Feeds**: [e.g., 4-6 servings]  

## Ingredients:
- [Ingredient 1]  
- [Ingredient 2]  
- [Ingredient 3]  
...  

## Instructions:
1. **Step 1**: [Detailed instructions for step 1.]  
2. **Step 2**: [Detailed instructions for step 2.]  
3. **Step 3**: [Detailed instructions for step 3.]  
...  

## Notes (Optional):
[Include any tips, serving suggestions, or additional notes.]  

Adding Your Recipes

There are two ways to add your recipes to this repository:

1. Create a GitHub Issue

  • Open a new issue in the repository.
  • Paste your recipe formatted with the template above.
  • Provide a title for your recipe in the issue.

2. Submit a Pull Request

  • Fork this repository.
  • Add your recipe as a new markdown file in the Recipes/ directory.
  • Use the format: Recipe_Name.md (replace spaces with underscores).
  • Submit a pull request with a brief description of your addition.

License

This repository is shared under the MIT License. Feel free to use, modify, and distribute the content with attribution.


Happy cooking! 🍳

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors