Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (82 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

120 lines (82 loc) · 2.27 KB

Contributing Guide

Thank you for considering contributing to this project 🚀

Development Setup

1. Clone the Repository

git clone https://github.com/l2dnjsrud/PhantomCrowd.git
cd PhantomCrowd

2. Backend Setup (FastAPI)

The backend is located in the backend/ directory.

cd backend
pip install -r requirements.txt
uvicorn app.main:app --reload

3. Frontend Setup (Vue 3 + TypeScript)

The frontend is located in the frontend/ directory.

cd frontend
npm install
npm run dev

🧪 Running Tests

cd backend
pytest tests/ -v

Pull Request Process

  1. Fork the repository

  2. Create a new branch

    git checkout -b feature/your-feature-name

  3. Make your changes

  4. Commit your changes

    git commit -m "feat: add contributing guide"

  5. Push to your fork

    git push origin feature/your-feature-name

  6. Open a Pull Request

Architecture Overview

Backend (backend/ – FastAPI)

  • app/ → Core application code (API routes, logic, main app)
  • data/ → Data files, datasets, or local storage resources
  • scripts/ → Utility scripts (setup, preprocessing, automation)
  • tests/ → Backend test cases
  • .env.example → Example environment configuration
  • requirements.txt → Python dependencies
  • pyproject.toml → Project configuration

Frontend (frontend/ – Vue 3 + TypeScript)

  • src/ → Main frontend source code (components, pages, logic)
  • index.html → Entry HTML file
  • package.json → Project dependencies and scripts
  • vite.config.ts → Vite configuration
  • tsconfig*.json → TypeScript configuration files
  • env.d.ts → Type definitions for environment variables

Other Important Files

  • docs/ → Documentation, reports, and screenshots
  • docker-compose.yml → Multi-container setup
  • Dockerfile → Container definition
  • CONTRIBUTING.md → Contribution guidelines
  • LICENSE → Project license

📌 Guidelines

  • Follow clean code practices
  • Write meaningful commit messages
  • Keep PRs small and focused

Thanks for contributing ❤️