NHMS

◦ NHMS: Nutrition and Health Management System

◦ Developed with the software and tools below.

📖 Table of Contents

📖 Table of Contents
📍 Overview
📦 Features
🚀 Getting Started
🛬 Deployed Version
🛣 Roadmap
🤝 Contributing
📄 License
👏 Acknowledgments

📍 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.

User account: Users can register for an account and then login using the register page.
Admin account: The admin account can be accessed here.

🛣 Project Roadmap

ℹ️ 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:

Submit Pull Requests: Review open PRs, and submit your own PRs.
Join the Discussions: Share your insights, provide feedback, or ask questions.
Report Issues: Submit bugs found or log feature requests for NUTRITION-MONITORING-SYSTEM.

Contributing Guidelines

Click to see contribution instructions

Fork the Repository: Start by forking the project repository to your GitHub account.
Clone Locally: Clone the forked repository to your local machine using a Git client.
```
git clone <your-forked-repo-url>
```
Create a New Branch: Always work on a new branch, giving it a descriptive name.
```
git checkout -b new-feature-x
```
Make Your Changes: Develop and test your changes locally.
Commit Your Changes: Commit with a clear and concise message describing your updates.
```
git commit -m 'Implemented new feature x.'
```
Push to GitHub: Push the changes to your forked repository.
```
git push origin new-feature-x
```
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

jamm59 / nhms Goto Github PK

nhms's Introduction