π Table of Contents
π Overview
NHMS is an easy to use web-based application where users are able to simply log in their nutrition choices, liquids, exercise, mood, energy levels, menstrual cycle and other symptoms that relate to chronic conditions.
π¦ Features
- User profiles: Users can create and login to personalised profiles.
- Admin dashboard: Selected administrators can view settings not available to regular users.
- Blog: Explore and view articles on different foods and recipes.
π Getting Started
Dependencies
Please ensure you have the following dependencies installed on your system:
node
- to run any commmands.
postgres
- to download and use the database provided.
cypress
- to run tests.
π§ Installation
- Clone the nhms repository:
git clone https://github.com/nutrition-monitoring-system/nhms.git
- Change to the source directory:
cd nhms/src
- Install the dependencies:
npm install
π€ Running nhms
npm run dev
in development and
npm run build
npm run start
in production.
π§ͺ Tests
npm run test OR npm run cy:run - # for headless mode
npm run cy:open - # to actively run tests in the Cypress browser.
Make sure that the dev dependencies
are installed using:
npm install -D
π¬ Deployed Version
Users can find the deployed version of nhms on Vercel with this link.
π£ Project Roadmap
- [x]
βΉοΈ Create a basic scaffolding for the nutrition management system.
- [ ]
βΉοΈ Expand out with recommendations for foods, per client.
- [ ]
βΉοΈ MORE TO BE ADDED.
π€ Contributing
Contributions are welcome! Here are several ways you can contribute:
Contributing Guidelines
Click to see contribution instructions
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear and concise message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
π License
This project is protected under the SELECT-A-LICENSE License.
For more details, refer to the LICENSE file.
π Acknowledgments
- Computing Science Department, University of Aberdeen
- Dr. Monika Gostic
- Dr. Chunyan Mu
- Dr. Bruce Scharlau
Return