Xianze is an annual technical fest that brings together students from colleges across the region to showcase their creativity, innovation, and technical expertise. Organized by the Mind bender's Association from Department of Software Systems and Computer Science (PG) Since 2011, Xianze features an exciting mix of technical and non-technical events aimed at encouraging participants to think critically and collaborate effectively. The event provides a platform for undergraduate and postgraduate students to present innovative ideas, compete in challenging events, and explore the latest trends in technology.
XIANZE EMS is an admin-only event management system designed for organizations that need to manage events, venues, and attendees. This repository contains the complete boilerplate for both the backend API and frontend application.
- 🔐 Admin-only authentication - Secure access for authorized administrators
- 📊 Event management - Create, update, and manage events (placeholder)
- 🎨 Modern UI - Built with Next.js and Tailwind CSS
- 🐳 Docker-ready - One-command deployment with Docker Compose
- 📝 Comprehensive docs - Beginner-friendly documentation
xianze/
├── backend/ # NestJS API server
│ ├── src/ # Source code
│ ├── docs/ # Backend-specific docs
│ ├── Dockerfile # Backend container
│ └── *.md # Documentation files
│
├── frontend/ # Next.js web application
│ ├── app/ # App Router pages
│ ├── docs/ # Frontend-specific docs
│ ├── Dockerfile # Frontend container
│ └── *.md # Documentation files
│
├── docker-compose.yml # Root orchestration
├── .editorconfig # Editor settings
├── .prettierrc # Code formatting
├── .eslintignore # Linting exclusions
├── .husky/ # Git hooks
└── README.md # This file
Before you begin, ensure you have the following installed:
| Tool | Version | Purpose |
|---|---|---|
| Docker | 20.10+ | Container runtime |
| Docker Compose | 2.0+ | Container orchestration |
| Node.js | 20+ | Local development (optional) |
| Git | 2.30+ | Version control |
The easiest way to run XIANZE is with Docker Compose:
# Production
./deploy.sh prod
# Development
docker compose up -d # Start backend + redis
cd frontend && bun run dev # Start frontend locally
# Stop all services (keeps data)
docker compose down
# Stop and remove all data
docker compose down -vFor development without Docker, see the individual READMEs:
XIANZE uses a multi-container architecture:
┌─────────────────────────────────────────────────────────────┐
│ xianze-network │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ frontend │────────▶│ backend │ │
│ │ (Next.js) │ │ (NestJS) │ │
│ │ Port: 3000 │ │ Port: 5000 │ │
│ └─────────────────┘ └────────┬────────┘ │
│ │ │
│ ┌────────▼────────┐ │
│ │ sqlite-data │ │
│ │ (Volume) │ │
│ └─────────────────┘ │
└─────────────────────────────────────────────────────────────┘
| Service | Port | Description |
|---|---|---|
| frontend | 3000 | Next.js web application |
| backend | 5000 | NestJS API server |
| Document | Description |
|---|---|
| README.md | Getting started with the backend |
| ARCHITECTURE.md | System design and patterns |
| CONTRIBUTING.md | How to contribute |
| DEPLOYMENT.md | Production deployment guide |
| SECURITY.md | Security considerations |
| TROUBLESHOOTING.md | Common issues and solutions |
| Document | Description |
|---|---|
| README.md | Getting started with the frontend |
| ARCHITECTURE.md | Component structure and patterns |
| CONTRIBUTING.md | How to contribute |
| TROUBLESHOOTING.md | Common issues and solutions |
- Framework: NestJS - Progressive Node.js framework
- Database: SQLite - Lightweight, file-based database
- ORM: TypeORM - TypeScript-first ORM
- Language: TypeScript
- Framework: Next.js 14+ - React framework with App Router
- Styling: Tailwind CSS - Utility-first CSS
- Language: TypeScript
- Containerization: Docker + Docker Compose
- Code Quality: ESLint + Prettier
- Git Hooks: Husky + lint-staged
This repository is designed for:
- Junior developers learning enterprise project structure
- Teams needing a clean starting point for event management
- DevOps engineers exploring Docker-based deployments
- Architects evaluating NestJS + Next.js combinations
We welcome contributions! Please read our contributing guides:
- Fork this repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Commit with a clear message (
git commit -m 'Add amazing feature') - Push to your branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
Built with ❤️ for the XIANZE community