Skip to content

Commit 2bb6e2f

Browse files
authored
update readme
1 parent d8dfc93 commit 2bb6e2f

1 file changed

Lines changed: 33 additions & 11 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# FitTrack - AI-Powered Fitness Coaching Platform
22

3-
![FitTrack Banner]()
4-
53
## πŸ‹οΈ Project Overview
64

75
FitTrack is a full-stack web application that democratizes access to personalized fitness coaching through AI-powered features. Built as my internship project, it combines modern web technologies with machine learning to provide intelligent workout planning, real-time form correction, and predictive progress analytics.
@@ -91,25 +89,44 @@ http://localhost:3000
9189
## πŸ“ Project Structure
9290

9391
fittrack/
92+
9493
β”œβ”€β”€ src/
94+
9595
β”‚ β”œβ”€β”€ app/ # Next.js app directory
96+
9697
β”‚ β”‚ β”œβ”€β”€ (auth)/ # Authentication pages
98+
9799
β”‚ β”‚ β”œβ”€β”€ (dashboard)/ # Dashboard pages
100+
98101
β”‚ β”‚ β”œβ”€β”€ api/ # API routes
102+
99103
β”‚ β”‚ └── layout.tsx # Root layout
104+
100105
β”‚ β”œβ”€β”€ processes/ # Multi-feature workflows
106+
101107
β”‚ β”œβ”€β”€ widgets/ # Composite UI components
108+
102109
β”‚ β”œβ”€β”€ features/ # Business features
110+
103111
β”‚ β”œβ”€β”€ entities/ # Domain objects
112+
104113
β”‚ └── shared/ # Reusable utilities
114+
105115
β”œβ”€β”€ prisma/
116+
106117
β”‚ β”œβ”€β”€ schema.prisma # Database schema
118+
107119
β”‚ └── migrations/ # Migration history
120+
108121
β”œβ”€β”€ public/ # Static assets
122+
109123
β”œβ”€β”€ docker-compose.yml # Docker configuration
124+
110125
β”œβ”€β”€ package.json # Dependencies
126+
111127
└── README.md # This file
112128

129+
113130
## πŸ“Š Performance Metrics
114131

115132
- ⚑ Lighthouse Score: **92/100**
@@ -133,21 +150,35 @@ fittrack/
133150
## πŸ“ˆ Database Schema
134151

135152
model User {
153+
136154
id String @id @default(cuid())
155+
137156
email String @unique
157+
138158
workouts Workout[]
159+
139160
workoutLogs WorkoutLog[]
161+
140162
subscription Subscription?
163+
141164
}
142165

166+
143167
model Exercise {
168+
144169
id String @id @default(cuid())
170+
145171
name String @unique
172+
146173
muscleGroups String[]
174+
147175
difficulty Int
176+
148177
instructions String
178+
149179
}
150180

181+
151182
// ... see prisma/schema.prisma for full schema
152183

153184
## 🀝 Contributing
@@ -167,17 +198,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
167198
## πŸ‘¨β€πŸ’» Author
168199

169200
**Your Name**
170-
- Portfolio: [yourwebsite.com](https://yourwebsite.com)
171201
- LinkedIn: [linkedin.com/in/yourprofile](https://linkedin.com/in/yourprofile)
172202
- GitHub: [@yourusername](https://github.com/yourusername)
173203
- Email: your.email@example.com
174204

175-
## πŸ™ Acknowledgments
176-
177-
- Built as part of my internship at [Company Name]
178-
- Special thanks to my mentor [Mentor Name]
179-
- Exercise data sourced from [Source]
180-
- Inspired by [Inspiration]
181-
---
182-
183205
**⭐ If you found this project helpful, please consider giving it a star!**

0 commit comments

Comments
Β (0)