This Health Tracker App allows users to manage and track their daily exercise routines, dietary habits, and health goals. The app includes a front-end for user interaction and a back-end API for data storage and retrieval.
To get started with the project, follow these steps:
-
Clone the Repository:
git clone https://github.com/YourUsername/health-tracker-app.git cd health-tracker-app -
Install Dependencies:
npm install
-
Start the HTTP Server:
npm start
The server will start on
http://localhost:3001. -
Access the Application:
Open your browser and navigate to
http://localhost:3000to access the application.
The project is structured as follows:
src/frontend/: Contains all front-end related files (HTML, CSS, JavaScript).html/: HTML files for different views.css/: Stylesheets for the application.js/: JavaScript files that manage front-end logic.
src/backend/: Contains the server setup and database configuration.server.js: Express server setup and API routes.
.gitignore: Specifies files and directories to be excluded from Git tracking.package.json: Lists dependencies and scripts for running the project.
The API provides endpoints to manage exercises, diets, and health goals.
- Endpoint:
/exercises - Method:
GET
No body is needed for this request.
[
{
"_id": "someid",
"type": "Running",
"duration": 30,
"date": "2024-07-29"
},
...
]
### Notes:
1. **Detailed API Documentation**: Continue to add detailed documentation for the `diets` and `goals` endpoints, similar to the exercise endpoints.
2. **Contributing and License Sections**: Adding a contributing section and a license section can make your project more accessible to other developers and clarify legal use.
3. **Use of Placeholders**: Replace `YourUsername` with your actual GitHub username in the clone command URL.
This README structure should meet the rubric criteria for documentation and provide clear, useful information for anyone using or contributing to your project.