https://github.com/ineshbose/portion-mate
Your daily meal-date and nutritionist
https://github.com/ineshbose/portion-mate
dissertation-project django expo react-native typescript
Last synced: 6 months ago
JSON representation
Your daily meal-date and nutritionist
- Host: GitHub
- URL: https://github.com/ineshbose/portion-mate
- Owner: ineshbose
- Created: 2021-10-11T14:56:25.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-28T16:12:52.000Z (over 1 year ago)
- Last Synced: 2025-04-07T20:50:23.148Z (about 1 year ago)
- Topics: dissertation-project, django, expo, react-native, typescript
- Language: TypeScript
- Homepage: https://inesh.xyz/portion-mate
- Size: 76 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Portion Mate
Portion Mate is an application that helps keep track of your food intake. This project has been proposed for Level 4 Individual Project (H) by Dr. Oana Andrei. To run this app locally, refer to the instructions in the manual.
## 📚 Documentation
Learn about this project through the different docs provided!
- [Getting Started](https://github.com/ineshbose/portion-mate/blob/develop/src/manual.md)
- [App Documentation](https://portion-mate.readthedocs.io/)
- [Repository Wiki](https://github.com/ineshbose/portion-mate/wiki/)
- [Dissertation](https://ineshbose.github.io/portion-mate/dissertation.pdf)
Stacks used
Dependency managers
Code style
_For more information, please refer to the [Wiki](https://github.com/ineshbose/portion-mate/wiki)._
## 🗺️ Project Layout
- [`.`](#) Root of repository with directories of different concerns
- [`package.json`](/package.json) is the repository module handler using [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/) and [lint-staged](https://github.com/okonet/lint-staged)
- [`docs`](/docs) contains files and assets related to documenting this project
- [`src`](/src) contains the source code for the application itself
- [`src/app`](/src/app) includes most of the source code for the Expo application
- [`src/server`](/src/server) is the source code for the Django backend server
- [`src/package.json`](/src/package.json) & [`src/pyproject.toml`](/src/pyproject.toml) list dependencies of the source code
- [`src/manual`](/src/manual.md) lists instructions on running the application locally
- [`src/.env.example`](/src/.env.example) is an example of a `.env` (git-ignored) file that can be used to read environment variables
- [`dissertation`](/dissertation) contains all files for the dissertation and being used on [Overleaf](https://www.overleaf.com/)
- [`.github`](/.github) Files used by GitHub to enable features used by this repository
- [`.github/workflows`](/.github/workflows) contains all YAMLs for instructions on running different [GitHub Actions](https://github.com/features/actions)
- [`timelog.md`](/timelog.md) is a required file for the project that includes a log of tasks and time spent
## 💽 License
While as much as I love open-source, unfortunately, this project is _not_ licensed for contributions or modifications. This is for confidence with the academic conduct of the university and avoid assisting any unintentional plagiarism. This repository is only public for reference. All dependencies for the project are licensed and used with compliance to requirements.
## 📟 Contact
If you have questions about this project, you can refer to the documents (including the [FAQ](https://portion-mate.readthedocs.io/en/latest/FAQ/)), but if you didn't find what you were looking for, or want to share feedback, you can send it to:
Inesh Bose - 2504266b@student.gla.ac.uk / Inesh.Bose@glasgow.ac.uk
Project Link: [https://github.com/ineshbose/portion-mate/](https://github.com/ineshbose/portion-mate/)
