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
10 changed files
with
137 additions
and
1 deletion.
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 +1,7 @@ | ||
# Development | ||
|
||
The application was developed during the academic year 2021-22 at the [University of Glasgow](https://www.gla.ac.uk/) as part of [Level 4 Individual Project](https://www.gla.ac.uk/coursecatalogue/course/?code=COMPSCI4025P) by student [Inesh Bose](https://inesh.xyz/) under the supervision of [Dr. Oana Andrei](http://www.dcs.gla.ac.uk/~oandrei/). | ||
|
||
The project makes use of best practices where possible, including issue-branching, code linting, automation with pipelines, etc. Loads of research has also gone into developing this, with credits and appreciation to all support and inspiration from developers on [Stack Overflow](https://stackoverflow.com/), [Reddit](https://reddit.com/), programming [Discord](https://discord.com/) servers, and [many many open source projects](https://github.com/). | ||
|
||
Regular meetings were scheduled with the supervisor. All information can be found on the [GitHub repository](https://github.com/ineshbose/portion-mate/). |
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 +1,25 @@ | ||
# Frequently Asked Questions (FAQ) | ||
|
||
## How is my data used? | ||
|
||
Your data is used only by you and whoever you wish to share it with by yourself (such as a nutritionist). Portion Mate allows you to turn your data into information for your dietary habits. | ||
|
||
## How do I customise my app? | ||
|
||
You can edit your account information in the settings, and also switch the application theme between light and dark modes. | ||
|
||
## How do I add/remove an item? | ||
|
||
The red floating action button gives you option to add an item (or a journal entry), and you can remove an item by going into the edit mode on the homepage. | ||
|
||
## Can I delete my account? | ||
|
||
If you wish to delete your account, you can scroll to the bottom of the settings page. Please know that this action will be irreversible. All your data will be deleted and cannot be recovered. | ||
|
||
## Can I copy this project? | ||
|
||
Unfortunately, the project is not open-source licensed at the moment - mostly due to the academic nature. The repository is public and available for reference and inspiration. | ||
|
||
## Where can I share feedback and thoughts? | ||
|
||
Any feedback and suggestion is more than welcome, and you can share them by emailing to [2504266b@student.gla.ac.uk](mailto:2504266b@student.gla.ac.uk). |
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 +1,19 @@ | ||
# Get Started | ||
|
||
Portion Mate is meant to be accessible from any platform, and not prioritise development on any specific set of devices. You can start using the tracker instantly on a browser by navigating to [#](#). You can also open the link on a mobile browser; however, if you wish you can also download the Portion Mate app on [Google Play Store](#) and [App Store](#). | ||
|
||
On opening the app for the first time, you will be presented with a login form. | ||
|
||
![login form](#) | ||
|
||
You can create an account by clicking on the appropriate button to switch the form that would ask for your details. | ||
|
||
![register form](#) | ||
|
||
On successful login / registration, you will be presented the homepage with the main dashboard. | ||
|
||
![homepage](#) | ||
|
||
The homepage allows you to log and edit your portion items. The initial items are in compliance with the [Eatwell Guide](https://www.gov.uk/government/publications/the-eatwell-guide), however, you can edit and remove as per your need. You can learn about each page on the dashboard in the [Navigation](/navigation/Home) section. | ||
|
||
If you would like to setup your own instance of Portion Mate, you can follow the guide at the code repository on [GitHub](https://github.com/ineshbose/portion-mate). |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Terms and Conditions | ||
|
||
Portion Mate has the usual terms and conditions like any other app. There needs to be a fair use of the app, and misuse will not be tolerated. | ||
|
||
# Privacy Policy | ||
|
||
Your privacy is important. Really, it is. No critical data will be asked or required from you. Data you provide about your logs is stored securely. |
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 |
---|---|---|
|
@@ -11,3 +11,5 @@ | |
</p> | ||
</p> | ||
</div> | ||
|
||
## |
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 +1,29 @@ | ||
# Home Page | ||
# Homepage | ||
|
||
The homepage is the landing page for logged-in users to immediately allow them to do the main task for the app - logging their food intake using the checkboxes. To log, you can either press the "`+`" button the right of the desired item, or just pressing an unchecked box. | ||
|
||
![add log](#) | ||
|
||
To remove a log, you can do the opposite (press the "`-`" button or a checked box). | ||
|
||
![remove log](#) | ||
|
||
Logs over the target can be entered by the "`+`" button. | ||
|
||
![over log](#) | ||
|
||
The default items loaded would be according to the [Eatwell Guide](https://www.gov.uk/government/publications/the-eatwell-guide) which are as follows: | ||
|
||
- **Carbohydrates**: 6 portions a day | ||
- **Fruits & Vegetables**: 6 portions a day | ||
- **Protein**: 3 portions a day | ||
- **Dairy**: 3 portions a day | ||
- **Oils & Fats**: 1 portion a day | ||
|
||
These can be removed or changed according to your preferred diet plan, which may also be vegan, dairy-free (lactose intolerance), or an allergy to something. To do so, you can press the edit button on the top right of the screen which would switch to edit view allowing you to change the target for an item, and/or delete or reorder it on the list. | ||
|
||
![edit items](#) | ||
|
||
To add an item, you can press the red action button in the bottom left of the screen. | ||
|
||
![add items](#) |
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 +1,23 @@ | ||
# Journals | ||
|
||
Journals allow you to maintain a diary for your diet journey. This could include what you ate and with who - food is a culture! These journals can also help a nutritionist understand you accurately. | ||
|
||
On opening the tab, journals for the current day are presented, however, you can navigate to previous days through the top bar, or the calendar icon on the top right. | ||
|
||
![change date](#) | ||
|
||
A journal contains time, meal, and your entry, and can be opened to full view by pressing on it, and exited out by the back button. | ||
|
||
![view journal](#) | ||
|
||
To add a journal, you can press the red action button on the bottom right with the "Add Entry" option. | ||
|
||
![add entry](#) | ||
|
||
This would present fields where you can enter information regarding your journal entry. Additionally, while entering your meals, you can log your portion items at the lower half of the screen instead of having to do so separately. | ||
|
||
![fill details](#) | ||
|
||
A journal can be deleted by opening it and pressing the Trash icon on the top right. | ||
|
||
![delete journal](#) |
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 +1,15 @@ | ||
# Resources | ||
|
||
The aim for this tab is to provide and share information / awareness about diets. These could include articles, research papers, and guides, and are curated by the administrator(s) to be available to you. | ||
|
||
To open a resource, you can press it, and read through. | ||
|
||
![open resource](#) | ||
|
||
If you want to see the original source, a link will be provided that can be opened from the top right. | ||
|
||
![open link](#) | ||
|
||
The resource can be bookmarked by pressing the star icon, and exit by the back button. | ||
|
||
![bookmark resource](#) |
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 +1,15 @@ | ||
# Statistics | ||
|
||
Portion Mate generates and displays graphs for you to visualise your food intake. These graphs can be generated using your logs on particular days and ranges, including "Daily", "Weekly" and "Monthly". For a custom day/range, you can press the calendar icon on the top right. | ||
|
||
![change date](#) | ||
|
||
While graphs may change for different ranges, the important and main one is the Pie Chart which helps to compare your intake to the [Eatwell Guide](https://www.gov.uk/government/publications/the-eatwell-guide) pie chart which constitutes the following: | ||
|
||
- **Carbohydrates**: ~33% | ||
- **Fruits & Vegetables**: ~33% | ||
- **Protein**: ~20% | ||
- **Dairy**: ~15% | ||
- **Oils & Fats**: ~5% | ||
|
||
![eatwell pie chart](#) |
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