About The Project

OwnRecipes is a recipe management site that allows users to create, share, and store their personal collection of recipes.

This project was forked from OpenEats. See the homepage of OpenEats for more information about it!

The usage for the app is intended for a single user or a small group. For my personal use, I would be an admin user and a few (about 5-6) friends and family would be normal users. Admin users can add other users to the project (no open sign-ups), make changes to the available Cuisines and Courses, and add to the homepage banner. Normal users just have the ability to add and edit recipes, and to add comments.

(back to top)

Getting started

Install via Docker

You can set up this project in no time using docker. This is the preferred way.

Official releases:

Read the docs about Running the App.

From source:

If you just want to run the whole thing for some testing or demo purpose, you can use docker, build it from source, and run it locally.

Install without Docker

If for any reason you don't want to use docker, read the guide about Running the App without Docker.

This is also the preferred method for Single-Board-Computers.

Updating/Upgrading

Read The Update guide

(back to top)

Coming from OpenEats?

Read The Migration Guide

(back to top)

Roadmap

• [x] Migrate OpenEats to CRA and TypeScript. Provide basic functions like create, edit and browse.
• [x] Add support for Raspberry Pi.
• [ ] Migrate private menu list features from OpenEats.
• [ ] Add more awesome stuff.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Please read the contribution guidelines in order to make the contribution process easy and effective for everyone involved.

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

See MAINTAINERS.md or SECURITY.md for more information.

(back to top)