Skip to content

Tayte555/Athletica

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏋️ Athletica

Athletica is a social fitness web application designed to help users create, manage, discover, and share workout routines. The platform allows users to build personalised training plans, explore community-created routines, follow other users, and stay motivated through social fitness features.

✨ Features

  • User authentication (Register / Login)
  • JWT protected routes
  • Create, edit, and delete workout routines
  • Public and private profile settings
  • Routine discovery and search
  • Follow system with private account requests
  • Notifications system
  • Routine optimisation and recommendations
  • Admin moderation tools

🛠️ Tech Stack

💻 Frontend

  • React + Vite
  • TypeScript
  • Tailwind CSS
  • React Router
  • Lucide Icons

⚙️ Backend

  • Node.js
  • Express.js
  • MongoDB
  • JWT Authentication

🚀 Running Athletica Locally (Development Environment)

📥 1. Clone the Repository

git clone https://github.com/Tayte555/Athletica.git
cd athletica

📦 2. Install Dependencies

Install all required dependencies for the root project, server, and client:

npm run install:all

Alternatively, you can install them separately:

npm install
npm run server:i
npm run client:i

🔐 3. Environment Variables

This project requires environment variables to run correctly for development.

Please create a .env file in the server root using the .env.example template.

These include values such as:

  • MongoDB connection string
  • JWT secret
  • Server port configuration
  • Any third-party service keys (if required)

Do not commit .env files to version control.

▶️ 4. Start the Development Server

To run both frontend and backend together:

npm run dev

This uses concurrently to start both services at the same time.

📜 Available Scripts

🔄 Run both frontend and backend

npm run dev

🖥️ Run backend only

npm run server

🌐 Run frontend only

npm run client

📥 Install backend dependencies

npm run server:i

📥 Install frontend dependencies

npm run client:i

🧩 Install everything

npm run install:all

🗂️ Project Structure

athletica/
│
├── client/        # React frontend
│
├── server/        # Express backend
│
├── package.json   # Root project scripts
│
└── README.md

📝 Notes

This project is currently configured for local development use.

Make sure MongoDB is running and your environment variables are correctly configured before starting the application.

If you experience setup issues, please contact me directly.

👨‍💻 Author

Developed by Tayte Keates

For setup support, environment variables, or project questions, please get in touch.

Instagram: @taytekeates LinkedIn: /in/taytekeates

Releases

No releases published

Packages

 
 
 

Contributors