Karp Family Recipes

A online database for the Karp family recipes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features and Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

(back to top)

Features and Usage

A fully functioning online database for recipes, featuring:

• Homepage with a random recipe and a navigation bar.
• Browse all recipes by title, by category, or by tag.
• View full recipe details, including commments and ratings.
• Search functionality.
• Authenticated registration and login system.

As a logged in user:

• Create, update, and delete on recipes, categories, and tags.
• Leave a comment and a rating on recipes.
• View other users and their comments, ratings, and changes.
• View all database changes.

(back to top)

Roadmap

• Sub-Categories
• Ratings on search page
• Live search
• Add more recipes!

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Jordan Karp - [email protected]

Project Link: https://github.com/JordanKarp/karp_recipes

(back to top)

Acknowledgments

• Jack Karp, the main source of recipes and feedback.

(back to top)