- π Overview
- π¦ Features
- π Structure
- π» Installation
- ποΈ Usage
- π Hosting
- π License
- π Authors
This repository contains the FitPulse Fitness Tracker MVP, a web application designed to help users set, track, and share their fitness goals. Built with a focus on simplicity and user engagement, it provides a streamlined experience for consistent fitness tracking. The core tech stack includes React for the frontend, Node.js with Express.js for the backend API, and MongoDB for data persistence.
Feature | Description | |
---|---|---|
π§βπ» | User Authentication | Secure user registration and login using email/password. Password hashing is done using bcrypt. JWTs are used for authentication. |
π― | Goal Setting | Users can define custom fitness goals with specific targets and deadlines. Supports various goal types (weight loss, distance, etc.). |
π | Progress Tracking | Users log their workouts, and the app calculates progress toward their goals. Progress is visualized using charts. |
π£οΈ | Social Sharing | Users can share progress updates via a simple copy-to-clipboard feature (Direct social media integration is a future enhancement). |
π | Data Visualization | Progress toward goals is displayed using charts, providing clear visual feedback. |
π± | Responsive Design | The application is responsive across different devices (desktop, tablet, mobile). |
fitness-tracker/
βββ apps/
β βββ web/ // React frontend application
β βββ package.json
β βββ public/
β β βββ index.html
β βββ src/
β β βββ App.tsx
β β βββ index.tsx
β β βββ components/ ...
β β βββ pages/ ...
β β βββ ...
β βββ ...
βββ backend/ // Node.js/Express backend API
βββ package.json
βββ src/
β βββ server.ts
βββ ...
- Node.js v18+
- npm 8+
- MongoDB 6.0+
-
Clone the repository:
git clone https://github.com/coslynx/FitPulse-Fitness-Tracker-MVP.git cd FitPulse-Fitness-Tracker-MVP
-
Navigate to the frontend directory:
cd apps/web
Install frontend dependencies:
npm install
-
Navigate to the backend directory:
cd ../../backend
Install backend dependencies:
npm install
-
Set up the database (ensure MongoDB is running):
- You'll need to create a database named "fitness-tracker" in your MongoDB instance. No additional setup is required for this MVP.
-
Configure environment variables:
- Create a
.env
file in both the frontend (apps/web
) and backend directories, using the.env.example
files as templates, and fill in yourJWT_SECRET
and database connection string.
- Create a
- Start the backend development server:
cd ../../backend npm run dev
- In a separate terminal, start the frontend development server:
cd ../../apps/web npm run dev
- Access the application:
- Web interface:
http://localhost:3000
- API endpoint (for testing purposes):
http://localhost:3001/api
- Web interface:
- Environment variables are stored in
.env
files (frontend and backend). JWT_SECRET
in.env
is crucial for secure authentication. Make sure this is set to a strong, unique value.
- User Registration: Use the web interface to create an account.
- Setting a Fitness Goal: Navigate to the Goals page, fill out the form, and create a goal.
- Logging a Workout: Navigate to the Workouts page, record your workout data, and save it.
This MVP can be deployed to any platform that supports Node.js and React applications. Heroku is a suggested option. You'll need to configure the environment variables appropriately for your chosen platform.
This Minimum Viable Product (MVP) is licensed under the GNU AGPLv3 license.
This MVP was entirely generated using artificial intelligence through CosLynx.com.
No human was directly involved in the coding process of the repository: FitPulse-Fitness-Tracker-MVP
For any questions or concerns regarding this AI-generated MVP, please contact CosLynx at:
- Website: CosLynx.com
- Twitter: @CosLynxAI
Create Your Custom MVP in Minutes With CosLynxAI!
```