Skip to content

Latest commit

 

History

History
104 lines (86 loc) · 10.7 KB

README.md

File metadata and controls

104 lines (86 loc) · 10.7 KB
Raw

Portion Mate logo

Portion Mate

GitHub deployments Codacy grade Code Climate maintainability Read the Docs

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!

Stacks used React native Expo Django Postgres Eva Design System
Dependency managers Yarn Poetry
Code style TypeScript ESLint Code style prettier Airbnb style guide Code style black

For more information, please refer to the Wiki.

🗺️ Project Layout

  • . Root of repository with directories of different concerns
  • package.json is the repository module handler using Yarn Workspaces and lint-staged
  • docs contains files and assets related to documenting this project
  • src contains the source code for the application itself
  • src/app includes most of the source code for the Expo application
  • src/server is the source code for the Django backend server
  • src/package.json & src/pyproject.toml list dependencies of the source code
  • src/manual lists instructions on running the application locally
  • src/.env.example is an example of a .env (git-ignored) file that can be used to read environment variables
  • dissertation contains all files for the dissertation and being used on Overleaf
  • .github Files used by GitHub to enable features used by this repository
  • .github/workflows contains all YAMLs for instructions on running different GitHub Actions
  • 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), 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/