ineshbose / portion-mate Goto Github PK
View Code? Open in Web Editor NEWYour daily meal-date and nutritionist
Home Page: https://inesh.xyz/portion-mate
Your daily meal-date and nutritionist
Home Page: https://inesh.xyz/portion-mate
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The app requirements has outlined a Journal tab.
Please provide a clear and concise description of what you want to happen.
Implement Journal in the backend, then interact with frontend.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The frontend technology is different and uses API with Django, therefore there should be token authentication.
Please provide a clear and concise description of what you want to happen.
Set that up using JWT, and connect to React Native.
Provide a clear and concise description of the bug.
Issue #19 attempted to create symlinks between docs/index.md
(required by Read The Docs) and docs/Home.md
(required by GitHub Wiki), however, now Home.md
displays index.md
.
Best to get rid of the file, however, while calling the Deploy Wiki action, create a copy of index.md
.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The UI at the moment is not at a good place. It is also defaulted to dark-mode which is not preferred by the supervisor.
Please provide a clear and concise description of what you want to happen.
Polish the UI and focus on light mode.
https://akveo.github.io/react-native-ui-kitten looks very interesting.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Authentication forms need to be provided in the frontend.
Please provide a clear and concise description of what you want to happen.
Add them.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
There are linting tests, and a few times before committing, linting check is forgotten.
Please provide a clear and concise description of what you want to happen.
Add a pre-commit hook. Solution still yet to be brainstormed.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Using pip
and npm
may not work since they're in src/backend
and src/frontend
respectively.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Whenever new pages are added, docs/_Sidebar.md
has to be adjusted constantly. Best if this can be done automatically.
Please provide a clear and concise description of what you want to happen.
Update Deploy Wiki action.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Pre-made actions.
Provide a clear and concise description of the bug.
This repository is also kept on Overleaf mainly to make changes in dissertation/
. Firstly, Overleaf does not support branching - so it pulls and pushes changes to/from the default branch which is develop
. Secondly and mainly, Overleaf also does not handle symlinks very well and therefore is unable to pull changes.
Please provide steps to reproduce the behaviour.
Please provide a clear and concise description of what you expected to happen.
Latest changes to appear.
Please provide a concise description of your environment.
Overleaf online.
Add any other context about the problem here.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Use a .env
file for environment variable values so that sensitive information can be removed from the repository.
Please provide a clear and concise description of what you want to happen.
Using django-environ
.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Other packages, scripts, configuration files.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Currently and by default, Django uses SQLite to keep a database which is also just file based. The most preferred and robust system for Django is PostgreSQL.
Please provide a clear and concise description of what you want to happen.
Change values in settings.py
to switch to PostgreSQL.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Other databases like MySQL, MongoDB, etc.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The Django backend and database needs an API to interact with the React Native frontend.
Please provide a clear and concise description of what you want to happen.
Add a REST API (using the already started/installed rest
app using Django REST Framework).
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The built-in templates are not "Portion Mate" themed.
Please provide a clear and concise description of what you want to happen.
Override the templates in src/backend/templates
for admin/base.html
(Admin Dashboard) and rest_framework/api.html
(Django REST Framework template) to use the theme colour navbar.
For the database, start creating models in the Django main
app.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The wireframes show a floating action button (FAB) that allow some functionality.
Please provide a clear and concise description of what you want to happen.
Implement it.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Libraries that provide this component, or using react-native
's Pressable
.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The React Native app needs to be available on the Apple App Store for iOS devices.
Please provide a clear and concise description of what you want to happen.
Refer https://reactnative.dev/docs/next/publishing-to-app-store
To get started on the back-end of the app, add a basic Django app to the repository.
src/
directory..gitignore
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
A lot of apps depend on internet connection, however, there are users that do not have a reliable one.
Please provide a clear and concise description of what you want to happen.
Use local storage that would also not require authentication. This expands accessibility. Data can be lost however.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The current wiki build is mostly scripted by myself, so best to export it to a separate action and use that.
Please provide a clear and concise description of what you want to happen.
Described above.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Other Wiki actions.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The logo is currently a PNG, however, initially it was planned to be a vector SVG.
Please provide a clear and concise description of what you want to happen.
Add paths and vectors and use SVG file in most places.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Many.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Moving an issue card from "In progress" to "Code review" is a long script.
Please provide a clear and concise description of what you want to happen.
Make a separate action and then use it. That is - https://github.com/ineshbose/project-card-action
Please provide a clear and concise description of any alternative solutions or features you've considered.
Other actions.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The Wiki of the repository would be more academic based (with meeting notes), etc. But it has always been a plan to have a public version built and deployed to ReadTheDocs.
Please provide a clear and concise description of what you want to happen.
The same files, with a separate YAML would be used to deploy on ReadTheDocs.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Since the repository is private, a possible way to deploy this on ReadTheDocs for free would be using API keys (similar to GitLab).
Add any other context or screenshots about the feature request here.
Update meeting notes to a format in the same PR.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The Django server database needs to be hosted on a server.
Please provide a clear and concise description of what you want to happen.
Deploy somewhere.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Currently, the frontend project uses classic Yarn v1 to manage dependencies, however Yarn v2 (Berry) has been out for a while.
Please provide a clear and concise description of what you want to happen.
Research and migrate if necessary. https://yarnpkg.com/getting-started/migration
Please provide a clear and concise description of any alternative solutions or features you've considered.
Switch to NPM.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The app requirement shows a Resources tab which would also include Eatwell Guide.
Please provide a clear and concise description of what you want to happen.
Implement!
Provide a clear and concise description of the bug.
Currently, there are some files that are duplicate, but under different name mostly due to required/expected formats like src/manual.md
, docs/index.md
, etc.
Please provide steps to reproduce the behaviour.
cat src/manual.md
& cat src/README.md
diff src/manual.md src/README.md
Please provide a clear and concise description of what you expected to happen.
Can also be seen as a feature. There should be no diff, but on making changes to any one file, there have to changes everywhere.
Please provide a concise description of your environment.
Windows & Ubuntu
Add any other context about the problem here.
It would be best to create symlinks with the core required files, for eg src/manual.md ==> src/README.md
, docs/index.md ==> docs/Home.md ==> docs/README.md
.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Right now, pip
is used to manage Python dependencies for the project.
Please provide a clear and concise description of what you want to happen.
Similar to using Yarn for frontend, switch to Poetry.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Users need to be reminded to log their portion intakes at certain times.
Please provide a clear and concise description of what you want to happen.
Implement.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
A short status report on the project is due at the end of Semester 1. The report must be absolute maximum three pages long (1-2 pages recommended) and covering the following (four P's):
Please provide a clear and concise description of what you want to happen.
Using the TeX template provided, write up the report by 13 December (Week 12), and convert to both PDF and Markdown (look into action and command).
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Currently, source code lives in src/
but also is futher classified into backend/
and frontend/
, so you have to change directory to run the app.
Please provide a clear and concise description of what you want to happen.
Reorganise src/
to have manage.py
and package.json
at that level, but also have a package.json
or something in root (look into Yarn Workspaces).
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
To have some default data on the app, it would be ideal to create a population script.
Please provide a clear and concise description of what you want to happen.
Write a population script for the Django database.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Testing will probably use a temporary database.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The wireframes used a bottom bar navigator with the theme colour instead of using system colour.
Please provide a clear and concise description of what you want to happen.
Recolour the bar accordingly.
To get started on the front-end of the app, add a basic React Native app to the repository.
src/
directory..gitignore
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Code linting is important for maintenance and review. It's just better practice.
Please provide a clear and concise description of what you want to happen.
Adopt Black linting along with a GitHub Action that checks everything to be linted.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Django does not adopt Black traditionally, but a lot of people are still going ahead with it. There are linters for Django as well, but Black blows many out of the water, and also there is previous experience with Black.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
There are 4 tabs on wireframes.
Please provide a clear and concise description of what you want to happen.
Add them in React Native.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The React Native app needs to be available on the Google Play Store for Android devices.
Please provide a clear and concise description of what you want to happen.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The project requires evaluation after the implementation which will be done with human users.
Please provide a clear and concise description of what you want to happen.
An ethics checklist / form needs to be signed and added to this repository so that it's publicly available.
Provide a clear and concise description of the problem.
Meeting notes in docs/
are not upto a good standard.
Review and formalise a template.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
There is a non-functioning sign-up form on the app right now.
Please provide a clear and concise description of what you want to happen.
Make sure it works and creates accounts.
Provide a clear and concise description of the bug.
Since the project uses TypeScript and react-native-dotenv
, there seems to be a warning. Ref goatandsheep/react-native-dotenv#269
Please provide steps to reproduce the behaviour.
api/auth.ts
.Please provide a clear and concise description of what you expected to happen.
No error/warnings.
Please provide a concise description of your environment.
Any. With @types/react-native-dotenv
installed.
Add any other context about the problem here.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Currently there are two types.ts
files in the frontend with more to follow. This can cause confusion and inconsistency during imports.
Please provide a clear and concise description of what you want to happen.
Create a types/
directory/module and place all definitions there.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The frontend needs to interact with the API.
Please provide a clear and concise description of what you want to happen.
Implement.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The app requires visualisation of portion logs.
Please provide a clear and concise description of what you want to happen.
Show graphs and a tab.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
To start off the UI, there needs to be a home page.
Please provide a clear and concise description of what you want to happen.
Create one.
For better viewing, evaluation and sharing, make the repository public.
It would be ideal to go public later in the course as that would reduce the scope for someone to plagarise.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
manage.py
can't be run simply and needs system arguments.
Please provide a clear and concise description of what you want to happen.
Default arguments to runserver
if none provided.
Please provide a clear and concise description of any alternative solutions or features you've considered.
Bash scripts.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The backend currently uses REST API, but now there seems to be preference to Graph QL.
Please provide a clear and concise description of what you want to happen.
Use django-graphene
in another app called graph
similar to rest
.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
User is currently in main
app, but can be switched out in a separate auth
app. Along with that, main
app can likely be renamed to something else.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Formatting frontend code will be a very good idea so that it is easily understandable through components and consistent.
Please provide a clear and concise description of what you want to happen.
Use Prettier along with a GitHub Action that checks everything to be formatted.
Please provide a clear and concise description of any alternative solutions or features you've considered.
ESLint will run along Prettier to ensure minimum errors.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
When the frontend makes calls to the backend using Axios, the full URL is being used everywhere.
Please provide a clear and concise description of what you want to happen.
Create an axios instance using axios.create()
that would use the base URL.
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
An action is provided at the header in the wireframes.
Please provide a clear and concise description of what you want to happen.
Add that with changing icons according to page.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.