forked from qgriffith-zz/OpenEats
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,5 @@ | ||
# OpenEats Project | ||
# OpenEats has moved | ||
|
||
[](https://travis-ci.org/RyanNoelk/OpenEats) | ||
Please see https://github.com/open-eats/OpenEats for the new repo location! | ||
|
||
OpenEats is a recipe management site that allows users to create, share, and store their personal collection of recipes. This fork uses Django Rest Framework as a backend and React (with flux) as a front end. | ||
|
||
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 recipes. Below are a few of the core features the app provides. | ||
|
||
- Creating, viewing, and editing recipes. | ||
- Browsing and searching for recipes. | ||
- Creating grocery lists | ||
- Quickly print recipe. | ||
- Linking recipes and ingredient grouping | ||
|
||
### [Read the docs on getting started here!](https://github.com/RyanNoelk/OpenEats/blob/master/docs/Running_the_App.md) | ||
|
||
# Contributing | ||
Please read the [contribution guidelines](https://github.com/RyanNoelk/OpenEats/blob/master/CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved. | ||
The docker setup has been streamlined, but is the same. If you have a custom script to setup your containers, they will still work. |