Skip to content

README.md

Latest commit

 

History

History
79 lines (51 loc) · 1.49 KB

README.md

File metadata and controls

79 lines (51 loc) · 1.49 KB
Raw

🏋️ Workout Tracker Web App (WIP)

A simple Node.js & Express-based web application to log and track workouts.

🚀 Features (Planned)

  • 📝 CRUD Operations – Log workouts (Create, Read, Update, Delete).
  • 🔎 Filtering – Search workouts by type, date, or duration.
  • 📊 Progress Tracking – View workout history.
  • 🛠️ REST API – Structured endpoints for workout management.

🛠️ Tech Stack

  • Backend: Node.js, Express.js
  • Database: MongoDB (via Mongoose)
  • Tools: Git, GitHub, Dotenv

📦 Installation

1. Clone the Repository

git clone https://github.com/NatBabi/Workout-Tracker-Web-App.git
cd Workout-Tracker-Web-App

2. Install Dependencies

npm install

3. Set Up Environment Variables

Create a .env file in the root directory and add the following:

PORT=5000
MONGO_URI=your-mongodb-connection-string

4. Run the Server

npm run dev

📖 API Endpoints

Workout Management

  • GET /api/workouts – Get all workouts.
  • POST /api/workouts – Add a new workout.
  • PUT /api/workouts/:id – Update a workout.
  • DELETE /api/workouts/:id – Remove a workout.

📜 License

This project is licensed under the MIT License – Feel free to use and modify.

✅ How to Add This to Your Repo

  1. Create a README file: 
    touch README.md
  2. Copy and paste this content into your README.md file.