README
¶
Recipya
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.
Features
- Manage your favorite recipes
- Import recipes from around the web
- Digitize paper recipes
- Organize your recipes into cookbooks
- Works seamlessly with Nextcloud 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
The installation instructions are written in the installation section of the documentation.
Contributing
Contributions are always welcome! Please open an issue, start a discussion, open a pull request or send an email at [email protected]. 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:
Other Recipe Manager Apps
Inspiration
This project was mainly coded to blasting the following albums:
- 4am
- Abysmal Dawn - Phylogenesis
- Archspire - Bleed the Future
- Beast In Black - Dark Connection
- Cattle Decapitation - Terrasite
- Ensiferum - From Afar
- Lofi Girl - lofi hip hop radio
- Lofi Girl - synthwave radio
- Mozart - Requiem Dm
- Pain - You Only Live Twice
- Sonata Arctica - Talviyö
- Wintersun - Wintersun
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package docs provides the read-only collection of files of the documentation website.
|
Package docs provides the read-only collection of files of the documentation website. |
|
website
Package website runs a go:generate command to build the Hugo static website.
|
Package website runs a go:generate command to build the Hugo static website. |
|
internal
|
|
|
app
Package app provides the app's configuration.
|
Package app provides the app's configuration. |
|
auth
Package auth implements the application's authentication system.
|
Package auth implements the application's authentication system. |
|
integrations
Package integrations provides integration services for different recipe manager applications.
|
Package integrations provides integration services for different recipe manager applications. |
|
jobs
Package jobs encapsulates cron job functionality using gocron.
|
Package jobs encapsulates cron job functionality using gocron. |
|
models
Package models provides various abstractions/representations of real-world concepts or objects.
|
Package models provides various abstractions/representations of real-world concepts or objects. |
|
scraper
Package scraper implements the logic to extract a recipe from a website.
|
Package scraper implements the logic to extract a recipe from a website. |
|
server
Package server implements the application's server API.
|
Package server implements the application's server API. |
|
services
Package services implements services, mainly the repository.
|
Package services implements services, mainly the repository. |
|
services/statements
Package statements provides SQLite statements for the service.
|
Package statements provides SQLite statements for the service. |
|
templates
Package templates provides types, template data and a render function for gohtml templates.
|
Package templates provides types, template data and a render function for gohtml templates. |
|
units
Package units provides measurement systems, and unit conversion.
|
Package units provides measurement systems, and unit conversion. |
|
utils/duration
Package duration provides the Duration struct to extend Go's time.Duration.
|
Package duration provides the Duration struct to extend Go's time.Duration. |
|
utils/extensions
Package extensions provides functions that extend basic Go types.
|
Package extensions provides functions that extend basic Go types. |
|
utils/regex
Package regex provides regular expressions for common tasks such as finding and validating email addresses, URLs, and other data formats.
|
Package regex provides regular expressions for common tasks such as finding and validating email addresses, URLs, and other data formats. |
|
Package main provides a tool for building and releasing a Go application.
|
Package main provides a tool for building and releasing a Go application. |
|
updater
module
|
|
|
Package web ensures the HTML is embedded into application's binary.
|
Package web ensures the HTML is embedded into application's binary. |
|
app
Package tailwind is used to build the project's Tailwind CSS file.
|
Package tailwind is used to build the project's Tailwind CSS file. |
|
components
Package components provides templ components.
|
Package components provides templ components. |
|
static
Package static ensures the web application's static files are embedded into the application's binary.
|
Package static ensures the web application's static files are embedded into the application's binary. |