Home

Awesome

Recipya

Build Report Contributions

GitHub tag License

Explore the docs · Demo

Introduction

A clean, simple and powerful recipe manager web application for unforgettable family recipes, empowering you to curate and share your favorite recipes. It is focused on simplicity for the whole family to enjoy.

Recipe page screenshot

Features

Getting Started

Installation

The installation instructions are written in the installation section of the documentation.

Building the Project

Follow these steps to build the project yourself:

  1. Clone the project. 
    git clone https://github.com/reaper47/recipya.git
  2. Install the required dependencies.
  3. Build the project.

Alternatively, you may use the development container. Recipya's Docker container includes all the necessary tools and dependencies you need to start writing code quickly.

Updating

Docker

Please follow these instructions to update your Docker instance.

Release build

If you installed a release build of Recipya, i.e. v1.0.0, then the software will notify you once an update is available. You can self-update the application from the settings dialog.

Let's explain the mechanism developers. Basically, a cron job is run every three days to check whether there is a new GitHub release. If so, the update indicators in the UI will be enabled. Once the user presses the "Update" button, the latest release is fetched, unpacked and the application restarted.

Contributing

Contributions are always welcome! Please open an issue, start a discussion, open a pull request or send an email at macpoule@gmail.com. The same applies if you have any feedback or need support.

You can also join our development and support channel on the Matrix space: #recipya:matrix.org. Matrix is similar to Discord but is open source.

Sponsors

I am grateful for any support that helps me continue to develop this project and to host it reliably. Your sponsorship will help me pay for the SendGrid Essentials plan to increase the number of emails that can be sent. The free plan currently used allows sending up to 100 emails per day.

You can sponsor me on GitHub Sponsors or Buy Me a Coffee.

Your support is greatly appreciated! A third of donations will be sent to the Armed Forces of Ukraine 🇺🇦

This project is supported by these kind people: <img src="scripts/sponsors/sponsors.svg" style="width:100%;max-width:800px;"/>

Other Recipe Manager Apps

Inspiration

This project was mainly coded to blasting the following albums: