Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 3.74 KB

README.md

File metadata and controls

124 lines (87 loc) · 3.74 KB
Raw

CodePerfect

Project Documentation

Table of Contents

  1. Introduction
  2. Getting Started
  3. Project Structure
  4. Usage

1. Introduction

This project is an Ionic application designed to help users track their weight and other health-related data. It provides a user-friendly interface for entering weight values and displays feedback on the entered data.

2. Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js installed on your local machine.
  • Ionic CLI installed globally.
  • Basic knowledge of Angular and Ionic.

Installation

  1. Clone this repository to your local machine:
git clone https://github.com/MnR-Hackathon-Pool-D/2023-hackathon-codeperfect.git
  1. Change to the project directory:
cd 2023-hackathon-codeperfect
  1. Install the project dependencies:
npm install

Running Spring Backend

  1. Make sure to use Java 17

  2. From root navigate to api

cd api
  1. Run backend on linux (Ensure permissions to gradlew)
./grdalew bootRun
  1. Run backend on Windows
gradlew.bat

Running an Ionic-Angular Project

  1. Install Ionic CLI
npm install -g @ionic/cli
  1. Serve the Application:
ionic serve

3. Project Structure

The project follows the following directory structure:

  • src/: Contains the source code for the application.
  • app/: Contains the Angular components, services, and modules.
  • assets/: Stores static assets such as images and icons.
  • pages/: Contains the different pages of the application.

4. Usage

Home Page

The Home Page provides an overview of the user's challenges and progress in various health-related areas.

  • The health data on display:
    • Steps
    • Water
    • Food
    • Weight

Leaderboard Page

The Leaderboard Page ranks users based on their points and achievements within the application. Key features and usage details include:

  • Points Ranking: Users are ranked based on the points they have earned by completing challenges. The leaderboard provides motivation for users to actively participate and improve their rankings.

  • Navigation: Users can navigate through the leaderboard to see the top performers, as well as their own ranking. This feature allows users to set goals and strive to move up the leaderboard.

  • Competition: The leaderboard is encouraging users to engage with the application's challenges to earn more points.

Profile Page

The Profile Page offers a personalized view of the user's health and wellness journey. Key features and usage details include:

  • User Profile: Users can view their own profile.

  • Connections: The profile page provides a section where users can see people that they may know.

  • Find Doctors: This feature can provides information about nearby healthcare services, clinics, and specialists.

Notifications Page

The Notifications Page keeps users informed about important updates, achievements, and interactions within the application. Key features and usage details include:

  • Notifications Feed: Users can access a feed of notifications that include various types of updates, such as:
    • New connections or friend requests
    • Challenge completion