Skip to content

ushanchamod/issue-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Issue Tracker

A modern, full-stack web application for tracking issues, featuring robust authentication, real-time statistics, and a beautiful, responsive UI.


Quick Start

Prerequisites

  • Node.js 18+
  • Python 3.13+
  • MongoDB running locally or in the cloud

Run the stack (dev)

  1. Backend API (server/):
cd server
npm install
# Create .env (see server/README.md)
npm run dev

Default: http://localhost:3000

  1. Frontend (client/):
cd client
npm install
# Optional: set VITE_API_URL (defaults to http://localhost:3000/api)
npm run dev

Default: http://localhost:5173

  1. AI Service (ai-service/):
cd ai-service
python -m venv .venv && .\.venv\Scripts\activate
pip install -r requirements.txt
# Set OPENAI_API_KEY in .env (see ai-service/README.md)
uvicorn app.main:app --reload --host 0.0.0.0 --port 8001

Default: http://localhost:8001


Features

  • User Authentication
    Secure registration and login with JWT & bcrypt
  • Issue Management
    Create, view, update, and delete issues via RESTful API Real-time data fetching, caching, and sync with React Query
  • AI Assistance
    Integrated AI service for contextual help and automation via backend proxy
  • Filtering & Search
    Filter and search by status, priority, or keywords (with debounced input)
  • Dashboard & Statistics
    Real-time statistics and charts aggregated on the server
  • Protected & Guest Routes
    Route protection with middleware based on authentication state
  • Responsive UI & Reusable Components
    Built with React's component-based architecture for flexibility and reusability
  • Validation & Error Handling
    Server-side validation with Zod and consistent error responses

Project Structure (High-Level)

Issue Tracker/
├── client/   # Frontend application
├── server/   # Backend application
├── ai-service/ # AI separate service (FastAPI)
└── README.md # Project overview

For details and environment variables, see: client/README.md, server/README.md, and ai-service/README.md.


AI Service (Overview)

The ai-service/ is a separate FastAPI service that provides AI-powered capabilities. It is accessed by the backend (server) as an internal dependency and proxied to the client. This keeps the client decoupled from model providers and centralizes configuration.


Architecture & Organization

This project is organized for scalability and maintainability:

  • Frontend and backend are fully decoupled
  • Clear modularization for components, routes, and utilities
  • Modern best practices for code quality, security, and performance

About

full-stack web application for tracking issues, featuring robust authentication, real-time statistics, and a beautiful, responsive UI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors