DRP group 28 featuring Nurdayana Muhd Faisal, Alfie Chenery, Miles Nash and Oliver Killane. Developing an app-based solution to prevent revision procrastination and study session distraction by mobile devices.
The video presented of the problem can be found here.
The final presentation slides and marketing material can be found in presentation/
.
This project is no longer actively maintained, and has been mirrored from gitlab. The Heroku deployment no longer runs & URIs are invalid. The CI/CD for this project was developed for gitlab & is not functional on github.
The documentation for the backend is generated from the dev
branch by our CI and can be found here.
Project includes marks for proper repository management. This project is no longer actively developed, and the CI is for gitlab, so is not functional here.
When making changes for new features, branch from, and eventually merge into the dev
branch. Master is used for the public facing, released version. This allows for the group to test for bugs, use and experience new features, and show new feature developments to stakeholders before publicly releasing.
When merging into dev
, deployment is done for our internal testing. Public deployment is done in master.
- Branch from
dev
- Work in new branch
- Create merge request for the feature
- Get request reviewed, go through cycles of review & improvement.
- Merge into
dev
, can now use test deployment. dev
pushed into Master.
Can be found here hosted on heroku.
Can be found here hosted on heroku.
Prefix/name-goes-here
Prefix | Description |
---|---|
enh | An enhancement, either a new feature, or improving an existing one. CI and test changes included. This should change both code behaviour and what behaviour we expect. |
fix | A bug fix to correct deviation of behaviour from expected. |
doc | Adding documentation, should not change any code behaviour! Comments only. |
ref | Refactoring of code, includes code changes but should not change behaviour. |
any | Anything not in the other categories. |
Commits must have a descriptive name, and contain the shortcodes of those working on the commit.
In enh/show-users-online:
Added green dot to show online status in friends menu
[ ac320, ok220 ]
- All merge requests need to be reviewed by another team member.
- Ideally before merging, the branch should be rebased against
dev
, though careful merging is fine.
For rebasing, simply go to the branch and use:
git rebase -i dev # -i for interactive, and always against dev
Can then pick changes, save & add before using
git rebase --continue
Once the rebase is complete, a force push is required
git push --force