Getting Started - Learnathon-By-Geeky-Solutions/codeclusters GitHub Wiki

🚀 Getting Started with YourShop

📦 Prerequisites

Make sure you have:

  • Node.js (v18 or higher)
  • npm (or pnpm)
  • Git

📁 Project Structure Overview

codeclusters/
├── admin/      # Admin dashboard (React.js)
├── backend/    # API server (Node.js)
├── frontend/   # User-facing app (React.js)

🛠️ Installation & Setup

1. Clone the Repository

git clone https://github.com/Learnathon-By-Geeky-Solutions/codeclusters.git
cd codeclusters

2. Install Dependencies

Backend

cd backend
npm install

Frontend

cd ../frontend
npm install

Admin Panel

cd ../admin
npm install

▶️ Running the Project

1. Start Backend

cd backend
npm run dev

2. Start Frontend

Open a new terminal window/tab:

cd frontend
npm run dev

3. Start Admin Panel

Open another terminal:

cd admin
npm run dev

By default:

  • Frontend runs on http://localhost:5173
  • Admin Panel runs on http://localhost:5174 (or another port if specified)
  • Backend runs on http://localhost:5000

⚙️ Environment Variables

Check for .env.example in each of the three folders (backend, frontend, admin). Copy and rename to .env, then configure as needed:

cp .env.example .env

Make sure all required environment variables (like database URIs, API endpoints, secrets) are set properly.

✅ Done!

Now your development environment should be up and running for:

  • 📱 Frontend (user-facing)
  • 🛠️ Backend (API and logic)
  • 👩‍💼 Admin (dashboard/control panel)

📄 Additional Resources

If you encounter any issues or have questions, feel free to open an issue in the repo!