Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

reshape readme #78

Merged
merged 1 commit into from
Jul 27, 2023
Merged

reshape readme #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# mealcurator
# mealCurator
[![Django CI](https://github.com/jtweeder/mealcurator/actions/workflows/django.yml/badge.svg)](https://github.com/jtweeder/mealcurator/actions/workflows/django.yml)
[![codecov](https://codecov.io/gh/jtweeder/mealcurator/branch/main/graph/badge.svg?token=35FD4Y6787)](https://codecov.io/gh/jtweeder/mealcurator)
## A webapp built with django for meal planning and recipe organization
### Description
Source code for https://www.mealcurator.com

Source code for Mealcurator.com
A django project that is intended to allow for learning a new framework while fulfilling a need. The application organizes recipes, allows meal planning, collects feedback, and in the future will provide recommendations to users.

This is a Django Project that runs mealcurator.com. The source code here is just for the web-application itself. All AI tools are in the sister repository.
# Contributions
Contributions are welcome. Feel free to start a discussion if you want to polish an idea, or tackle a listed issue.

# Issues
If you run across issues on mealcurator.com please feel free to log an issue with as much detail as possible. Key things to include will be the steps to recreate. Screen shots of said steps and visuals of what is not working as intended or the error you are getting.
### How to Contribute
1. Fork repository
2. Create a branch for your code-changes
4. Make code changes following good coding practices, documentation and test generation.
3. Commit and push to your forked repository branch
4. Create a pull-request to the main branch

### Testing/Database for contributors
The development database is currently restricted. So start a discussion if you have an idea that depends heavily on needing the development database. I will run final testing against the development database before merging pull-request.

## Issues
If you find a issue while using the application, please log an issue with actions to recreate. If you see an issue please feel free to attempt to recreate and report.

The issues board will also be where open clean-up needs or incremental feature adds will be that are open to helpers.

## Discussions
This area is for any questions or ideas you may have on a feature before development starts. Ideas that are maybe less than totally formed or architected will be here for discussion until more well formed and can be turned into development efforts.

# Contributions
Have a great idea feel free to fork the repo and throw out a pull request targeting the dev branch. All code contributions will require test coverage prior to being merged into dev (preferred), but definatly before they make it into the main branch.

Have a great idea, but not too sure where to start or direction to take feel free to submit it as a modification request via an issue. From there we can discuss and shape it into a pull-request.
# Data Model Architecture
Coming soon...overview of models and how they interact.