https://github.com/reaper47/recipya-rs
A clean, simple and powerful recipe manager your whole family will enjoy.
https://github.com/reaper47/recipya-rs
recipe-manager self-hosted
Last synced: 6 months ago
JSON representation
A clean, simple and powerful recipe manager your whole family will enjoy.
- Host: GitHub
- URL: https://github.com/reaper47/recipya-rs
- Owner: reaper47
- License: agpl-3.0
- Created: 2024-07-18T13:45:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-09T02:37:43.000Z (6 months ago)
- Last Synced: 2025-04-11T02:07:45.867Z (6 months ago)
- Topics: recipe-manager, self-hosted
- Language: Rust
- Homepage: https://recipes.musicavis.ca
- Size: 9 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Recipya Rust
**A clean, simple and powerful recipe manager your whole family will enjoy.**
[![Demo][demo-shield]][demo-url]
[![Documentation][docs-shield]][docs-url]
[![Matrix][matrix-shield]][matrix-url]
[![][github-release-shield]][github-release-link]
[![build-status-shield]][build-status-url]
[![contributions-shield]][contributions-url]
[build-status-shield]: https://img.shields.io/github/actions/workflow/status/serde-rs/serde/ci.yml?branch=master
[build-status-url]: https://github.com/reaper47/recipya-rs/actions/new
[contributions-shield]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
[contributions-url]: https://github.com/reaper47/recipya-rs/issues
[demo-shield]: https://img.shields.io/badge/demo-996300?style=flat
[demo-url]: https://recipes.musicavis.ca
[docs-shield]: https://img.shields.io/badge/documentation-5d782e?style=flat
[docs-url]: https://recipes.musicavis.ca/guide/docs/
[matrix-shield]: https://img.shields.io/badge/Matrix-000000?style=flat&logo=matrix&logoColor=white
[matrix-url]: https://app.element.io/#/room/%23comfyui_space%3Amatrix.org
[github-release-shield]: https://img.shields.io/github/v/release/reaper47/recipya-rs?style=flat&sort=semver
[github-release-link]: https://github.com/reaper47/recipya-rs/releases
## 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.
## Warning
The [Recipya](https://github.com/reaper47/recipya) project is currently being rewritten in Go as
announced [here](https://github.com/reaper47/recipya/discussions/422). The Rust project is not ready for production nor
to selfhost.
The user interface should look exactly the same as the original.
## Features
- Manage your favorite recipes
- Import recipes from around the web
- Digitize paper recipes
- Organize your recipes into cookbooks
- Works seamlessly with [Nextcloud Cookbook](https://apps.nextcloud.com/apps/cookbook)
- Automatic conversion to your preferred measurement system (imperial/metric)
- Calculate nutritional information automatically
- Print any recipe in your collection
- Prevent your device from going to sleep while viewing a recipe
- Follows your system's theme (light/dark)
- Cross-compiled for Windows, Linux, and macOS
## Getting Started
### Installation
The installation instructions are written in
the [installation section](https://recipes.musicavis.ca/guide/docs/installation/) of the documentation.
### Building the Project
#### Current state
Dependencies:
1. Rust: https://www.rust-lang.org/
2. Nodejs: https://nodejs.org/en/download/package-manager
3. PostgreSQL: https://www.postgresql.org/download/ and the [pg_cron extension](https://github.com/citusdata/pg_cron)
4. Diesel: `cargo install diesel_cli --no-default-features --features postgres`
PostgreSQL extensions:
Add the following to `/var/lib/pgsql/data/postgresql.conf` once `pg_cron` is installed:
- `shared_preload_libraries = 'pg_cron'` <- Uncomment this line
- `cron.database_name = 'recipya'` <- New line
To build:
1. Set the environment variables in `.cargo/config.toml`
2. Run recipya: `cargo run -p recipya`
#### Development Container
You may use the devcontainer to help develop Recipya. The `RECIPYA_DATABASE_URL` environment variable in your
`.cargo/config.toml` file would be `RECIPYA_DATABASE_URL = "postgres://postgres:postgres@localhost:5432/recipya"`.
#### Once recipya-rs becomes the defacto Recipya:
Follow these steps to build the project yourself:
1. Clone the project.
```bash
git clone https://github.com/reaper47/recipya-rs.git
```
2. Install the required [dependencies](https://recipes.musicavis.ca/guide/docs/development/intro/#dependencies).
3. [Build](https://recipes.musicavis.ca/guide/docs/development/build/) the project.
Alternatively, you may use
the [development container](https://recipes.musicavis.ca/guide/docs/development/devcontainer/).
Recipya's Docker [container](https://github.com/reaper47/recipya-rs/tree/main/.devcontainer) includes all the necessary
tools and dependencies you need to start writing code quickly.
## Contributing
Contributions are always welcome! Please open an issue, start
a [discussion](https://github.com/reaper47/recipya/discussions), 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](https://app.element.io/#/room/#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](https://github.com/sponsors/reaper47) or
[Buy Me a Coffee](https://www.buymeacoffee.com/macpoule).
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:
# Inspiration
This project was mainly coded to blasting the following albums:
- [4am](https://www.youtube.com/watch?v=tBcPji_jRDc)
- [Abysmal Dawn - Phylogenesis](https://www.youtube.com/watch?v=xJMybqRMedk&pp=ygUMYWJ5c21hbCBkYXdu)
- [Archspire - Bleed the Future](https://www.youtube.com/watch?v=o8H9ahswldM)
- [Atavistia - Cosmic Warfare](https://www.youtube.com/watch?v=VjJ_zb4RF2E)
- [Beast In Black - Dark Connection](https://www.youtube.com/watch?v=7NyON-NzBr4)
- [Cattle Decapitation - Terrasite](https://www.youtube.com/watch?v=x6rEDMqM36I)
- [Ensiferum - From Afar](https://www.youtube.com/watch?v=6r8OPu3SRSM)
- [Kahlmah - Swamplord](https://www.youtube.com/watch?v=FhMsOB88dfo&list=PLkROH3Eqs0T9b5E2WDDOS0JgYLf24_dNs)
- [Lofi Girl - lofi hip hop radio](https://www.youtube.com/watch?v=jfKfPfyJRdk)
- [Lofi Girl - synthwave radio](https://www.youtube.com/watch?v=4xDzrJKXOOY)
- [Mozart - Requiem Dm](https://www.youtube.com/watch?v=pBGVfwOLU1w0)
- [Necrophobic - In the Twilight Grey](https://www.youtube.com/watch?v=eDFD6YnMid8)
- [Pain - You Only Live Twice](https://www.youtube.com/watch?v=obgCEoLzLs4)
- [Sonata Arctica - Talviyö](https://www.youtube.com/watch?v=x6rEDMqM36I)
- [Wintersun - Wintersun](https://www.youtube.com/watch?v=W0M3HAMus7g&pp=ygUPd2ludGVyc3VuIGFsYnVt)
- [Wintersun - Time I & II](https://www.youtube.com/watch?v=dl3pkdAzHrw)