The motivation for our product is to provide users with awareness of the amount of calories, protein, macros, micros, vitamins, fiber, sugar, etc., they intake with each item they consume. We aim to motivate users to better their health, as health should be the top priority in one’s life. Poor health can lead to various diseases and heart issues, and our app seeks to combat that.

HealthQuest is a minimalistic, motivational, user-friendly interface that tracks calorie intake along with other nutritional information.

• What problem does it solve? It helps users understand and monitor what they’re consuming, addressing the challenge of staying consistent in reaching health goals, such as maintaining a calorie surplus or deficit.
• Why does it exist? This app is for individuals who seek an easy way to stay informed about their health and take control of it.

Please ensure you have the following installed:

• Node.js - Download and install
• Git - Download and install

1. Clone the Repository

   Open your terminal and run the following command to create a local copy of the project:

   git clone https://github.com/hvpham-yorku/project-Group_06.git

   This command downloads the project repository into a folder called project-group_6 in your current directory.

2. Navigate to the Project Directory

   Move into the project folder:

   cd project-group_6

   You’re now in the main directory, where all project files are stored, essential for running further commands.

3. Install Dependencies

   To ensure the app runs smoothly, install all required packages:

   npm install

   This command reads the package.json file and installs all listed dependencies for both the frontend and backend.

4. Set Up Environment Variables

   Environment variables such as API keys and database URLs need to be configured.

   • Create a new file called .env in the root of the project directory.

   • Open .env in a text editor and add your environment variables. For example:

     API_KEY=your_api_key
     DATABASE_URL=your_database_url
     

   Save and close the file. These variables are kept secure in .env and are not shared publicly.

5. Run the Application

   • For production mode, run:

     npm run start

   • For development mode, which reloads as you edit code, use:

     npm run dev

   • Open a web browser and go to http://localhost:3000 to see the application running locally.

1. Fork and Clone the Repository

   • Go to the main repository on GitHub and click on "Fork."

   • Clone your forked repository to your local system:

     git clone https://github.com/your-username/project-Group_06.git

2. Create a New Branch

   Create a new branch to keep your work separate:

   git checkout -b feature-or-fix-name

   Replace feature-or-fix-name with a descriptive name, like add-dashboard-chart or fix-login-issue.

3. Make and Commit Changes

   • Stage your changes:

     git add .

   • Commit with a clear message:

     git commit -m "Description of changes, e.g., 'Added dashboard chart component'"

4. Push Changes to Your Fork

   Push your branch to GitHub:

   git push origin feature-or-fix-name

5. Open a Pull Request (PR)

   • On your GitHub fork, switch to the branch you pushed.
   • Click "Compare & pull request" to create a PR. In the PR, provide an overview of your changes and their purpose.

We’ve made significant progress on the health tracking system, and here’s a detailed look at what’s been completed across the frontend, backend, and documentation:

• Calorie Tracker UI: A visual tracker for monitoring calorie progress.
• Meal Logging UI: A searchable interface for logging meals with nutritional data.
• Water Tracker UI: A visual tracker with reminders to help users stay hydrated.
• Step Tracker UI: Tracks daily steps with adjustable goals.

• Calorie Tracking Storage: Efficient storage and retrieval of calorie data.
• Meal Data Storage: Reliable storage for meal logs with nutritional calculations.
• Water Intake Data: Secure storage for water tracking with customizable goals.
• Step Tracking Data: Efficient storage and retrieval of steps data.
• Secure Authentication: User login with encrypted credentials for enhanced security.
• API & Route Setup: API endpoints for all frontend UI elements and their routes.
• Efficient Data Management: Improved handling of calorie, meal, water, and step tracking data.

To support developers, we have added detailed documentation covering:

1. Routes Documentation: Information on all API endpoints and their usage.
2. Models Documentation: Descriptions of how data is structured and stored.
3. Controllers Documentation: Explanation of backend logic and features.

You can find all documentation in the /docs folder. For a breakdown of tasks and subtasks, check out our Trello board, where everything is organized for easy tracking.