Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💪 IronSync

A gym & fitness companion app that helps you and your friends train smarter, eat better, and stay motivated together.

IronSync started as a simple idea between two friends who lift together: an app to track our workouts, follow a plan, keep our nutrition in check, and — most importantly — keep each other accountable and hyped. Streaks, shared PRs, supplement notes... the stuff that actually keeps a gym crew going.

This repo is where we plan, design, and build it.


✨ What IronSync does (the vision)

IronSync is built around five pillars:

🏋️ Workouts

  • Log daily workouts
  • Follow structured training plans
  • Track personal records (PRs)

🥗 Nutrition

  • Build a diet plan
  • Count calories & macros
  • Log what you eat

👤 Profile & Health

  • Personal profile
  • Body measurements over time
  • Health issues / notes so plans train you safely

👥 Friend Group

  • A private crew of friends
  • Share supplement results
  • PR leaderboard across the crew
  • Streak leaderboard — see who's got the longest run going 🔥
  • Get pinged when someone beats your PR

🔥 Motivation

  • Daily streak counter
  • Nudges to keep the habit alive

💡 Adding an idea? Just drop a bullet under the right pillar above — no table formatting to fight with. For the detailed breakdown with build phases, see docs/FEATURES.md.


🗺️ Where we're headed

We're building in phases so we always have something working. Short version:

  1. MVP — profile + log a workout + streak counter (the core daily loop)
  2. PRs & Friend Group — personal records, the crew, PR leaderboard & "someone beat your PR" alerts
  3. Nutrition — diet plans, calorie & macro tracking, food log
  4. Supplements & polish — supplement result sharing, notifications, refinement

Full plan with milestones: docs/ROADMAP.md.


🧱 Tech stack

  • Frontend: React Native + Expo — one codebase for iOS + Android.
  • Language: TypeScript.
  • Backend / data: Firebase — authentication, Cloud Firestore database, push notifications, and Cloud Functions, so two people can ship without running our own servers.

See docs/ARCHITECTURE.md for why we picked these.


📁 Repo structure

IronSync/
├── README.md              ← you are here
├── app/                   ← the Expo (React Native + TS) mobile app
│   └── src/
│       ├── screens/       ← full screens        (Pruthvi / UI)
│       ├── components/    ← reusable UI pieces   (Pruthvi / UI)
│       ├── theme/         ← colors & spacing     (Pruthvi / UI)
│       ├── models/        ← shared data types    (the contract — both)
│       └── services/      ← Firebase & data access (jaikanth / backend)
├── backend/               ← Firestore rules, indexes & Cloud Functions (jaikanth)
├── docs/                  ← all planning & design docs
│   ├── FEATURES.md        ← every feature, broken down
│   ├── ROADMAP.md         ← phased build plan & milestones
│   ├── DATA_MODEL.md      ← how data is organized (Firebase sketch)
│   ├── ARCHITECTURE.md    ← tech decisions & trade-offs
│   └── CONTRIBUTING.md    ← how we work together (branches, workflow)
├── .github/               ← issue templates for tracking ideas & bugs
└── .gitignore

Who owns what: Pruthvi builds UI in app/src/{screens,components,theme}, jaikanth builds the backend in app/src/services + backend/, and both keep the shared data shapes in app/src/models in sync — that's the contract that lets you work in parallel.

Run the app: cd app && npm install && npm start — see app/README.md.


🚀 Getting started

Right now this is a planning repo — no app code yet. To get involved:

  1. Read docs/FEATURES.md to see what we're building.
  2. Read docs/ROADMAP.md to see what's next.
  3. Check docs/CONTRIBUTING.md for how we branch, commit, and divide work.

When we start coding, setup instructions go here.


👥 The team

Two friends who lift and wanted an app that actually fit how they train. 🤝


📄 License

Not chosen yet — see docs/CONTRIBUTING.md for the decision we need to make.

About

Gym & fitness companion app — workout tracking, diet plans, streaks, and shared PRs with your crew

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages