Release for Iteration 3

README.md

@@ -16,21 +16,21 @@ Users can set goals for each of these areas and monitor their daily progress tow
 
 ### User Authentication
 
-- **Sign Up / Login:** Users can create accounts and log in to track their personal health data.
-- **Password Recovery:** Users can reset their passwords through a secure email-based process.
+- **Sign Up:** Users can create accounts with an email and password.
+- **Login / Logout:** Users can log in with their email and password to track their personal health data.
 
 ### Health Tracking
 
-- **Steps Tracking:** Users can log and view their daily steps.
-- **Water Intake Tracking:** Users can record their daily water intake.
-- **Sleep Tracking:** Users can track their sleep duration.
-- **Exercise Tracking:** Users can log their exercise time and view historical data.
-- **Weight Tracking:** Users can track their weight over time.
+- **Steps:** Users can log and view their daily steps.
+- **Water Intake (glasses):** Users can record their daily water intake.
+- **Sleep (hours):** Users can track their sleep duration.
+- **Exercise (minutes):** Users can log their exercise time and view historical data.
+- **Weight (lbs):** Users can track their weight over time.
 
 ### Goals and Progress Monitoring
 
 - **Daily Goals:** Users can set and track daily goals for steps, water intake, sleep, exercise, and weight.
-- **Progress Reports:** Users can view graphical reports of their progress towards their goals.
+- **Progress Reports:** Users can view graphical reports of their performance against their set goals.
 
 ## Technology Stack
 
@@ -42,3 +42,7 @@ Users can set goals for each of these areas and monitor their daily progress tow
 # How to run
 
 Refer to the [README in the code directory](https://github.com/BUMETCS673/seprojects-cs673olf24team3/blob/dev/code/README.md)
+
+### Link to the deployed website
+
+https://peak-performance-3c40e2c0ebea.herokuapp.com/

code/README.md

@@ -1,7 +1,3 @@
-# Link to our website
-
-https://peak-performance-3c40e2c0ebea.herokuapp.com/
-
 ## Open up a split screen terminal:
 
     Change directory into the 'server' folder:
@@ -14,27 +10,26 @@ https://peak-performance-3c40e2c0ebea.herokuapp.com/
 
 ## Using docker to run all 3 services (mongodb, api, client)
 
-Make sure to start the docker engine by starting up Docker Desktop. Note make sure to log in.
+Make sure to start the docker engine by starting up Docker Desktop and logging in.
 
     docker login -u your_username -p your_password --This will log you in using bash
 
-### Make sure you're in the code folder
+### Useful docker commands (make sure you have navigated into the code folder):
 
-### This will stop all containers from running
+This stops all containers from running
 
     docker stop $(docker ps -aq)
 
-### This removes all containers (deletes them)
+This removes all containers (deletes them)
 
     docker rm $(docker ps -aq)
 
-
-### This will remove all images
+This removes all images
 
     docker rmi $(docker images -q)
 
 
-# The commands below will build and run the server and client docker file for the development environment
+## Build and run the server and client docker file for the development environment:
 
     To build:
         Step 1: Open a terminal and cd into the code folder
@@ -47,7 +42,7 @@ Make sure to start the docker engine by starting up Docker Desktop. Note make su
         Open your browser and navigate to http://localhost:3000
 
 
-# The commands below will tag and upload the api and client images to Docker Hub
+## Tag and upload the API and client images to Docker Hub:
 
     Step 1:  Tag the images
             - docker tag api-dev:latest cs673olf24team3/peak-performance:api-dev

code/client/README.md

@@ -1,4 +1,4 @@
-# Getting Started with Create React App
+# React App
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
@@ -63,29 +63,3 @@ Run the following commands in the project directory:
 ## Learn More
 
 You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)