ValvX Projektplattform - Stargate Framework

This repository contains the Stargate framework for the ValvX Projektplattform - a comprehensive project management system designed for collaboration, file management, and project tracking.

Project Overview

ValvX is a full-stack project management platform that provides the following core features:

• User Management & Authentication - Secure JWT-based authentication system
• Project Management - Create and manage projects with role-based access control
• Task Management - Assign, track, and complete tasks within projects
• File Management - Upload, organize, and version files within projects
• Wiki System - Create and organize documentation in a hierarchical structure
• Time Reporting - Track time spent on tasks for project accounting
• Notification System - Keep users informed about important updates
• Meeting Management - Schedule and organize team meetings

Technology Stack

• Frontend:

  • React (TypeScript)
  • Material UI (MUI Joy)
  • Vite build system
  • Axios for API communication
  • React Router for navigation

• Backend:

  • Django
  • Django REST Framework
  • JWT Authentication
  • PostgreSQL database

Project Structure

The project is structured as follows:

Backend

backend/
├── core/                 # Core app (Users, Projects, Tasks)
├── files/                # File management app
├── wiki/                 # Wiki documentation app
├── notifications/        # Notifications and meetings app
├── valvx_project/        # Django project settings
└── manage.py             # Django management script

Frontend

frontend/
├── public/               # Static assets
├── src/
│   ├── components/       # Reusable UI components
│   ├── context/          # React context (Auth, etc.)
│   ├── hooks/            # Custom React hooks
│   ├── pages/            # Page components
│   ├── services/         # API services
│   ├── types/            # TypeScript definitions
│   ├── utils/            # Utility functions
│   ├── App.tsx           # Main application component
│   └── main.tsx          # Application entry point
├── index.html            # HTML template
└── vite.config.ts        # Vite configuration

Getting Started

Prerequisites

• Node.js (v16 or higher)
• Python (v3.9 or higher)
• PostgreSQL

Setup

1. Clone the repository

git clone https://github.com/your-organization/valvx-platform.git
cd valvx-platform

2. Backend Setup

cd backend
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver 0.0.0.0:8000

3. Frontend Setup

cd frontend
npm install
npm run dev

API Endpoints

The API is structured around the following main resources:

• /api/token/ - JWT token authentication
• /api/users/ - User management
• /api/projects/ - Project management
• /api/tasks/ - Task management
• /api/files/ - File management
• /api/wiki/ - Wiki documentation
• /api/notifications/ - Notification system
• /api/meetings/ - Meeting scheduling

Development

This framework is designed as a foundation for future development. The current implementation provides the basic structure and models, but specific business logic and detailed features will need to be implemented according to requirements.

License

[Your License Information]