Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coslynx/fitlog-txsgnu
Project: Initial Prototype for User Feedback and Iteration. Created at https://spectra.codes, which is owned by @Drix10
https://github.com/coslynx/fitlog-txsgnu
code-generation developer-tools devops expressjs fitness-tracker goal-setting machine-learning mvp nextjs postgresql progress-tracking react rest-api social-sharing software-development typescript user-interface web-app zustand
Last synced: 1 day ago
JSON representation
Project: Initial Prototype for User Feedback and Iteration. Created at https://spectra.codes, which is owned by @Drix10
- Host: GitHub
- URL: https://github.com/coslynx/fitlog-txsgnu
- Owner: coslynx
- Created: 2024-08-19T04:58:23.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-08-19T05:07:00.000Z (about 1 month ago)
- Last Synced: 2024-09-25T15:41:28.675Z (1 day ago)
- Topics: code-generation, developer-tools, devops, expressjs, fitness-tracker, goal-setting, machine-learning, mvp, nextjs, postgresql, progress-tracking, react, rest-api, social-sharing, software-development, typescript, user-interface, web-app, zustand
- Language: TypeScript
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
FitLog-txsgnu
A web application for tracking fitness goals, progress, and sharing achievements with friends.
Developed with the software and tools below.
## 📑 Table of Contents
- 📍 Overview
- 📦 Features
- 📂 Structure
- 💻 Installation
- 🏗️ Usage
- 🌐 Hosting
- 📄 License
- 👏 Authors
## 📍 Overview
This repository contains a Minimum Viable Product (MVP) called "FitLog-txsgnu" that empowers fitness enthusiasts to track their progress towards their goals and share their achievements with their network. The application combines personalized goal setting, comprehensive progress tracking, and social features to create a motivating and engaging experience.
## 📦 Features
| Feature | Description |
|--------------------|--------------------------------------------------------------------------------------------------------------------|
| **Goal Setting** | Users can set personalized fitness goals in various categories (weight loss, exercise, nutrition) with specific targets, timelines, and desired outcomes. |
| **Progress Tracking** | Track workouts, log food intake, and visualize progress towards goals through charts and graphs. Receive personalized feedback on performance. |
| **Social Sharing** | Connect with friends, share achievements and milestones, and send motivational messages to support each other. |
| **User Profile** | Manage personal information, view goal history, and adjust account settings. |
| **Dashboard** | Get a personalized overview of progress, recent activities, and insights based on logged data. |
| **User-Friendly Interface** | A simple and intuitive interface design ensures a smooth and engaging user experience for all levels of fitness enthusiasts. |
| **Data Security** | Robust security measures protect user information through secure storage, encryption, and access controls. |
| **Scalable Architecture** | Designed to handle a growing user base and increasing data volume. |
| **API Integrations** | Potential integration with fitness trackers and other health apps for seamless data synchronization. |
| **Regular Updates** | The application will be regularly updated with new features and improvements based on user feedback. |
## 📂 Structure
```text
└─ components
├─ GoalForm.tsx
├─ WorkoutLog.tsx
├─ MealLog.tsx
├─ ProgressChart.tsx
├─ FriendRequest.tsx
├─ FriendList.tsx
├─ UserProfile.tsx
├─ GoalCard.tsx
├─ ActivityCard.tsx
├─ SocialFeed.tsx
├─ Navigation.tsx
└─ Header.tsx
└─ pages
├─ api
│ ├─ auth
│ │ └─ [...nextauth].js
│ ├─ goals
│ │ └─ [id].js
│ ├─ workouts
│ │ └─ [id].js
│ ├─ meals
│ │ └─ [id].js
│ ├─ friends
│ │ └─ [id].js
│ └─ user
│ └─ [id].js
├─ _app.tsx
├─ dashboard
│ └─ page.tsx
├─ goals
│ └─ page.tsx
├─ workouts
│ └─ page.tsx
├─ meals
│ └─ page.tsx
├─ friends
│ └─ page.tsx
└─ profile
└─ page.tsx
└─ prisma
├─ migrations
│ └─ 20240208004202_init
│ ├─ migration.sql
│ └─ migration.prisma
└─ schema.prisma
└─ styles
└─ globals.css
└─ utils
├─ helpers.js
└─ index.js
└─ app
└─ layout.tsx
└─ next.config.mjs
└─ package.json
└─ postcss.config.mjs
└─ tailwind.config.js
└─ tsconfig.json
└─ README.md
```
## 💻 Installation
### 🔧 Prerequisites
- Node.js
- npm
- Docker
### 🚀 Setup Instructions
1. Clone the repository:
- `git clone https://github.com/spectra-ai-codegen/FitLog-txsgnu.git`
2. Navigate to the project directory:
- `cd FitLog-txsgnu`
3. Install dependencies:
- `npm install`
## 🏗️ Usage
### 🏃♂️ Running the Application
1. Start the development server:
- `npm start`
2. Open your browser and navigate to [http://localhost:3000](http://localhost:3000).
### ⚙️ Configuration
Adjust configuration settings in `next.config.mjs` or `.env` file.
### 📚 Examples
- **Goal Setting:** Set a weight loss goal of 2 pounds per week, with a target weight of 150 pounds and a timeline of 8 weeks.
- **Progress Tracking:** Log a 30-minute cardio workout, including the type of exercise, duration, intensity, and calories burned.
- **Social Sharing:** Share your latest workout achievement with your friends and send motivational messages to encourage them.
## 🌐 Hosting
### 🚀 Deployment Instructions
1. Install the Heroku CLI:
- `npm install -g heroku`
2. Login to Heroku:
- `heroku login`
3. Create a new Heroku app:
- `heroku create`
4. Deploy the code:
- `git push heroku main`
### 🔑 Environment Variables
- `DATABASE_URL`: Database connection string for PostgreSQL.
## 📜 API Documentation
### 🔍 Endpoints
- **GET /api/users**: Retrieves a list of users.
- **POST /api/users**: Creates a new user.
- **GET /api/users/:id**: Retrieves a specific user's information.
- **PUT /api/users/:id**: Updates a user's information.
- **DELETE /api/users/:id**: Deletes a user.
### 🔒 Authentication
- Use NextAuth.js for user authentication, supporting various providers like Google, Facebook, and GitHub.
### 📝 Examples
- `curl -X GET http://localhost:3000/api/users`
## 📜 License
This project is licensed under the [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/).
## 👥 Authors
- **Author Name** - [Spectra.codes](https://spectra.codes)
- **Creator Name** - [DRIX10](https://github.com/Drix10)
🌐 Spectra.Codes
Why only generate Code? When you can generate the whole Repository!
