Skip to content

Development Setup

AstronDaniel edited this page Dec 21, 2025 · 1 revision

πŸ’» Development Setup

Prepare Your Workspace

Configure your local environment to start contributing to CampusVault.


πŸ› οΈ Prerequisites

Ensure you have the following tools installed:

Tool Version Purpose
Node.js v18+ Frontend runtime
Python v3.10+ Backend runtime
PostgreSQL v14+ Database
Docker Latest Containerization (Optional)

βš™οΈ Backend Configuration

  1. Clone & Enter:

    git clone https://github.com/AstronDaniel/CampusVault.git
    cd CampusVault/backend
  2. Virtual Environment:

    python -m venv venv
    source venv/bin/activate
  3. Dependencies:

    pip install -r requirements.txt
  4. Environment Variables: Copy .env.example to .env and update database credentials.

🎨 Frontend Configuration

  1. Navigate:

    cd ../admin-frontend
  2. Install:

    npm install
  3. Run:

    npm run dev

← Back to Developer Docs β€’ Next: Contributing Guide β†’

Clone this wiki locally