Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coslynx/fitlog-qwtfzh
Project: Track fitness goals, share progress, and stay motivated with friends. Created at https://coslynx.com
https://github.com/coslynx/fitlog-qwtfzh
api-integration code-generation community-driven developer-tools devops fitness-app fitness-tracking goal-setting javascript machine-learning mongodb mvp mvp-development next-js node-js progress-tracking react social-fitness software-development tailwindcss
Last synced: about 1 month ago
JSON representation
Project: Track fitness goals, share progress, and stay motivated with friends. Created at https://coslynx.com
- Host: GitHub
- URL: https://github.com/coslynx/fitlog-qwtfzh
- Owner: coslynx
- Created: 2024-09-07T02:49:24.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T02:53:29.000Z (2 months ago)
- Last Synced: 2024-10-06T20:04:05.763Z (about 1 month ago)
- Topics: api-integration, code-generation, community-driven, developer-tools, devops, fitness-app, fitness-tracking, goal-setting, javascript, machine-learning, mongodb, mvp, mvp-development, next-js, node-js, progress-tracking, react, social-fitness, software-development, tailwindcss
- Language: TypeScript
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
FitTrack
A collaborative fitness tracker MVP that empowers users to achieve their goals together.
Developed with the software and tools below.
## 📑 Table of Contents
- 📍 Overview
- 📦 Features
- 📂 Structure
- 💻 Installation
- 🏗️ Usage
- 🌐 Hosting
- 📄 License
- 👏 Authors
## 📍 Overview
This repository houses the FitTrack Minimum Viable Product (MVP), a web application designed to enhance the fitness journey by connecting individuals through collaborative goal setting, progress tracking, and social interaction.
## 📦 Features
| | Feature | Description |
|----|--------------------|--------------------------------------------------------------------------------------------------------------------|
| ⚙️ | **Architecture** | The codebase is structured using a modular architecture, separating functionalities into distinct directories, promoting maintainability and scalability. |
| 📄 | **Documentation** | Comprehensive README.md file outlines project details, instructions, and essential information for developers and users. |
| 🔗 | **Dependencies** | Utilizes essential libraries like React, Next.js, Tailwind CSS, Zustand, Express.js, Mongoose, NextAuth.js, and others to ensure seamless functionality. |
| 🧩 | **Modularity** | The code is structured for modularity, with dedicated directories for components, pages, and utilities, promoting code reuse and manageability. |
| 🧪 | **Testing** | Implemented unit tests using Jest and integration tests using Cypress to ensure code quality and functionality. |
| ⚡️ | **Performance** | The application incorporates performance optimization techniques, such as caching and lazy loading, to deliver a smooth user experience. |
| 🔐 | **Security** | Employs robust security measures, including input validation, authentication, and authorization, to safeguard user data and application integrity. |
| 🔀 | **Version Control**| Uses Git for version control with a clear branching strategy, allowing for efficient collaboration and code management. |
| 🔌 | **Integrations** | Seamlessly integrates with popular fitness trackers like Fitbit, Garmin, and Apple Watch through their respective APIs. |
| 📶 | **Scalability** | Designed with scalability in mind, using a cloud-based architecture and techniques like database sharding and serverless functions for handling increased user traffic. |
## 📂 Structure
```text
├── components
│ ├── Button.tsx
│ ├── Header.tsx
│ ├── Layout.tsx
│ ├── GoalInput.tsx
│ ├── ProgressChart.tsx
│ └── SocialShareButton.tsx
├── pages
│ ├── api
│ │ ├── auth.ts
│ │ ├── goals.ts
│ │ └── progress.ts
│ ├── _app.tsx
│ ├── index.tsx
│ ├── dashboard.tsx
│ └── login.tsx
├── styles
│ └── global.css
├── utils
│ ├── helpers.ts
│ ├── api.ts
│ ├── auth.ts
│ └── validation.ts
├── config
│ └── next-auth.config.ts
├── middleware
│ └── authentication.ts
├── .env
├── package.json
├── README.md
└── tailwind.config.ts
```
## 💻 Installation
### 🔧 Prerequisites
- Node.js
- npm
- Docker
### 🚀 Setup Instructions
1. Clone the repository:
- `git clone https://github.com/coslynx/FitTrack-qwtfzh.git`
2. Navigate to the project directory:
- `cd FitTrack-qwtfzh`
3. Install dependencies:
- `npm install`
## 🏗️ Usage
### 🏃♂️ Running the Application
1. Start the development server:
- `npm run dev`
2. Open your browser and navigate to [http://localhost:3000](http://localhost:3000).
### ⚙️ Configuration
Adjust configuration settings in `next.config.js` or `.env`.
### 📚 Examples
- **📝 Example 1**: Creating a Goal - The user can set a specific weight loss goal, define the desired weight, and set a deadline for achieving the target.
- **📝 Example 2**: Tracking Progress - The user can connect their Fitbit account and automatically track their daily steps, calories burned, and other fitness metrics.
- **📝 Example 3**: Sharing Progress - The user can share their progress on their social feed, join fitness groups with like-minded individuals, and encourage each other through motivational messages.
## 🌐 Hosting
### 🚀 Deployment Instructions
#### Vercel
1. Login to your Vercel account.
2. Choose "New Project" from the dashboard.
3. Select "Import Git Repository" and provide the link to the GitHub repository.
4. Configure any deployment settings as required.
5. Click "Deploy."
#### Netlify
1. Create a Netlify account.
2. Select "New site from Git."
3. Connect your GitHub account and select the "FitTrack-qwtfzh" repository.
4. Configure any deployment settings as required.
5. Click "Deploy."
#### GitHub Pages
1. Navigate to the GitHub repository's Settings.
2. Under "Pages," select a branch to deploy.
3. Choose the "root" directory for deployment.
4. Click "Save."
#### Heroku
1. Install the Heroku CLI:
- `npm install -g heroku`
2. Log in to Heroku:
- `heroku login`
3. Create a new Heroku app:
- `heroku create`
4. Deploy the code:
- `git push heroku main`
### 🔑 Environment Variables
- `DATABASE_URL`: The connection string for the MongoDB Atlas database.
## 📜 API Documentation
### 🔍 Endpoints
- **GET /api/auth/signup**: Creates a new user account.
- **GET /api/auth/login**: Logs in an existing user.
- **GET /api/auth/logout**: Logs out the current user.
- **GET /api/goals**: Retrieves all goals for the current user.
- **POST /api/goals**: Creates a new goal for the current user.
- **PUT /api/goals/:id**: Updates an existing goal.
- **DELETE /api/goals/:id**: Deletes a goal.
- **GET /api/progress/:userId**: Retrieves progress data for a specific user.
- **POST /api/progress/:goalId**: Records new progress data for a specific goal.
- **PUT /api/progress/:id**: Updates existing progress data.
- **DELETE /api/progress/:id**: Deletes progress data.
### 🔒 Authentication
Uses JWT tokens for authentication, provided by NextAuth.js
### 📝 Examples
- `curl -X GET http://localhost:3000/api/goals`
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👥 Authors
- **[CosLynxAI](https://github.com/coslynx)**
🌐 CosLynx.com
Create Your Custom MVP in Minutes With CosLynxAI!
