Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shmoopi/simplydelicio.us

Simple and Delicious Recipes
https://github.com/shmoopi/simplydelicio.us

Last synced: 6 days ago
JSON representation

Simple and Delicious Recipes

Awesome Lists containing this project

README

        

SimplyDelicio.us Logo

# SimplyDelicio.us

Welcome to [simplydelicio.us](https://simplydelicio.us/), a delightfully simple recipe website built with [Hugo](https://gohugo.io). Enjoy only the recipe, nothing else. Whether you're a culinary enthusiast or just looking for some tasty inspiration, SimplyDelicio.us has you covered!

## Quick Start

Get cooking in no time with SimplyDelicio.us:

1. Download or clone the project
2. Open a new Terminal/Console window
3. Change directory to the project folder: `cd /path/to/simplydelicio.us/`
4. Install Hugo with the [Hugo quick start guide](https://gohugo.io/getting-started/quick-start/)
5. Start the Hugo server: `hugo server -D`
6. Open a browser window to view the [Web Server](http://localhost:1313/)

## Contributing

We welcome contributions to SimplyDelicio.us! Whether it's adding new recipes, fixing bugs, or improving documentation, every contribution is appreciated.

### Guidelines

Before making a contribution, please ensure that:

- Your contribution adheres to the recipe template provided.
- You have tested your changes locally to ensure they work as expected.
- Your code follows the project's coding standards.

### Recipe Template

Use the following [template](recipe_template.md) when adding a new recipe:

```markdown
---
title: "Recipe Title"
summary: "Brief summary or description of the recipe"
date: YYYY-MM-DD
draft: true
time: "Estimated preparation/cooking time (e.x. 1h 30m)"
output: "Estimated servings or quantity (e.x. 1 pan)"
tags: ["tag1", "tag2", "tag3"]
featured_image: "image-name.png"
---

## Ingredients

- [ ] ½ Tsp - Ingredient 1
- [ ] 2 Tbsps - Ingredient 2
- [ ] 1¾ Cups - Ingredient 3
- [ ] ...

## Directions

1. Step 1
2. Step 2
3. Step 3
4. ...
```

### Steps to Contribute

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository, detailing the changes you've made, recipes added, etc.

## License

This project is licensed under the [MIT License](LICENSE). Feel free to use and modify the code as per the terms of the license.