This is a web application that allows users to manage their chores and plan their
meals. Users can create, update, and delete chores and meals. They can also view
their chores and meals in a dashboard view.
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://gitlab.informatik.uni-halle.de/akmrx/chorechef/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
### Libraries
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
- date-fns
- Air Datepicker
***
## Installation
# Editing this README
### Getting the Source Code
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
```bash
./startapp.sh
```
## Name
Choose a self-explaining name for your project.
This should start the frontend on [http://localhost:5173](http://localhost:5173)
and the backend on [http://localhost:8000](http://localhost:8000).
Note that this is the expected configuration for the application to work properly.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Usage
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
### Dashboard
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
The dashboard offers a view of the chores and meals at a glance. The user can see
the chores for the selected day and the meals for the next 4 days including the
current day. The user can navigate to the next or previous day using the arrows inside
the bar displaying the date.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
#### Chores
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
One can mark a chore as done only from the Dashboard. The corresponding chore will
be removed from the list of chores for the day and the next execution date will be
calculated, as well as the next assigned user.
Chores that are overdue, are dispayed in red.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
#### Meals
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
On the dashboard, the user can see the meals planned for the next 4 days. Each meal
has a name and a description, which can be used for noting ingredients or preparation
steps. Meals can not be edited from the dashboard.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
### Mealplan View
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
The mealplan view lets the user see, edit, add and delete meals of the next 7 days.
Otherwise it is similar to the dashboard view.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
### Chores View
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
As with the Mealplan view, the chores view lets the user see, edit, add and delete
chores. However, it is not possible to check off chores from this view. One can only
edit chores here.
A chore has a name, a desctiption, a frequency and a User assigned to it. The frequency
is a number of days, weeks or months. It is used to calculate the next execution
date of the chore. If a chore was marked done by accident, the user can reverse this
action by moving the chore back by one frequency unit. By checking a chore, the next
assigned user cycles through the list of all users.
## License
For open source projects, say how it is licensed.
### Settings
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
This is a general settings view. Currently it only allows for the management of users.
