Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coslynx/project-1723912636967-e4sw0b
Project: Core Feature Prototyping for User Feedback. Created at https://spectra.codes, which is owned by @Drix10
https://github.com/coslynx/project-1723912636967-e4sw0b
code-generation developer-tools devops fitness-community fitness-tracker goal-tracking machine-learning mvp mvp-development nextjs postgresql prisma progress-tracking react social-fitness software-development tailwindcss typescript user-dashboard zustand
Last synced: about 2 months ago
JSON representation
Project: Core Feature Prototyping for User Feedback. Created at https://spectra.codes, which is owned by @Drix10
- Host: GitHub
- URL: https://github.com/coslynx/project-1723912636967-e4sw0b
- Owner: coslynx
- Created: 2024-08-17T16:37:17.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-17T16:45:46.000Z (5 months ago)
- Last Synced: 2024-10-16T18:57:56.095Z (3 months ago)
- Topics: code-generation, developer-tools, devops, fitness-community, fitness-tracker, goal-tracking, machine-learning, mvp, mvp-development, nextjs, postgresql, prisma, progress-tracking, react, social-fitness, software-development, tailwindcss, typescript, user-dashboard, zustand
- Language: TypeScript
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
project-1723912636967-e4sw0b
A web application for fitness goal tracking and social sharing.
Developed with the software and tools below.
## 📑 Table of Contents
- 📍 Overview
- 📦 Features
- 📂 Structure
- 💻 Installation
- 🏗️ Usage
- 🌐 Hosting
- 📄 License
- 👏 Authors
## 📍 Overview
This repository houses the Minimum Viable Product (MVP) for a **fitness goal tracker web application**. The application aims to provide users with a platform to:
- **Set personalized fitness goals**
- **Track their progress**
- **Share achievements with their friends**
The MVP is built using a modern tech stack, including:
- **React** for the user interface
- **TypeScript** for strong typing and code maintainability
- **Next.js** for server-side rendering and static site generation
- **PostgreSQL** for a robust and scalable database
- **Tailwind CSS** for rapid prototyping and styling
- **Zustand** for simple and efficient state management
- **Prisma ORM** for easy database interactions
- **NextAuth.js** for secure user authentication
- **Sentry** for comprehensive error tracking and monitoring
## 📦 Features
| Feature | Description |
|--------------------|--------------------------------------------------------------------------------------------------------------------|
| **Goal Setting** | Users can create and customize their fitness goals with specific targets, deadlines, and tracking parameters. |
| **Progress Tracking**| Users can monitor their progress towards goals by logging weight, exercise sessions, and other relevant data. |
| **Social Sharing** | Users can connect with friends and share their achievements, providing encouragement and fostering a supportive community. |
| **Data Visualization** | Visualizations (e.g., graphs, charts) offer insights into progress trends, motivating users to stay on track. |
| **User-Friendly Interface** | The application is designed with a clear and intuitive user interface for ease of navigation and interaction. |
| **Third-Party Integrations** | The application can integrate with popular fitness trackers and wearable devices for automated data capture. |
| **Secure User Data** | Robust security measures protect user data, ensuring privacy and confidentiality. |
| **Scalability** | The application is built with scalability in mind, capable of handling a growing user base and data volume. |
| **Regular Updates** | The application will receive regular updates based on user feedback and industry trends. |
## 📂 Structure
```
fitness-goal-tracker/
├── pages
│ ├── api
│ │ └── auth
│ │ └── [...nextauth].js
│ ├── _app.tsx
│ ├── index.tsx
│ ├── goals
│ │ └── page.tsx
│ └── dashboard
│ └── page.tsx
├── components
│ ├── GoalCard.tsx
│ ├── GoalForm.tsx
│ ├── GoalList.tsx
│ ├── Header.tsx
│ ├── Layout.tsx
│ ├── Sidebar.tsx
│ ├── SocialFeed.tsx
│ ├── Profile.tsx
│ └── InputField.tsx
├── styles
│ └── globals.css
├── prisma
│ ├── migrations
│ │ └── 20231120115405_init
│ │ └── migration.sql
│ └── schema.prisma
├── utils
│ ├── helpers.js
│ └── index.js
├── .eslintrc.js
├── next.config.mjs
├── tailwind.config.js
├── tsconfig.json
├── postcss.config.mjs
└── package.json
```
## 💻 Installation
### 🔧 Prerequisites
- Node.js
- npm
- Docker (Optional for database setup)
### 🚀 Setup Instructions
1. Clone the repository:
- `git clone https://github.com/spectra-ai-codegen/project-1723912636967-e4sw0b.git`
2. Navigate to the project directory:
- `cd project-1723912636967-e4sw0b`
3. Install dependencies:
- `npm install`
4. Setup the database:
- **Option 1 (Docker):**
- `docker-compose up -d`
- **Option 2 (Local PostgreSQL):**
- Install PostgreSQL locally
- Create a new database
- Configure database credentials in `.env` file
5. Run database migrations:
- `npx prisma db push`
## 🏗️ 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.mjs` or `.env` files as needed.
### 📚 Examples
- **Goal Creation:** Create a new fitness goal with a specific target, deadline, and tracking parameters.
- **Progress Logging:** Log your weight, exercise sessions, and other data to track progress towards goals.
- **Social Sharing:** Connect with friends, share your achievements, and provide encouragement.
- **Data Visualization:** Explore data visualizations (e.g., graphs, charts) to gain insights into your progress trends.
## 🌐 Hosting
### 🚀 Deployment Instructions
#### **Vercel (Recommended)**
1. Create a new Vercel project.
2. Connect the repository to Vercel.
3. Deploy the application using Vercel's deployment tools.
#### **Netlify**
1. Create a new Netlify site.
2. Connect the repository to Netlify.
3. Deploy the application using Netlify's deployment tools.
#### **Heroku (Alternative)**
1. Install the Heroku CLI: `npm install -g heroku`
2. Login to Heroku: `heroku login`
3. Create a new Heroku app: `heroku create`
4. Configure environment variables (DB_HOST, DB_USER, DB_PASS) in Heroku.
5. Deploy the code: `git push heroku main`
### 🔑 Environment Variables
- `NEXT_PUBLIC_APP_NAME`: The name of your application (e.g., "Fitness Goal Tracker")
- `NEXTAUTH_URL`: Your application's URL (e.g., "http://localhost:3000")
- `NEXTAUTH_SECRET`: A secret key for securing authentication (generate using `openssl rand -base64 32`)
- `DATABASE_URL`: The URL of your PostgreSQL database (e.g., `postgresql://user:password@host:port/database`)
- `SENTRY_DSN`: Your Sentry DSN for error tracking (optional)
## 📜 License
This application is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
## 👥 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!
