tabungin/docs/README.md

Tabungin Documentation

Welcome to the Tabungin documentation! This guide will help you understand the project structure, features, and development workflow.

📚 Documentation Structure

Features

Detailed documentation for each feature implementation:

• Maintenance Mode - System maintenance mode with admin bypass
• Admin Auto-Redirect - Automatic admin routing after login
• Admin Profile & Dashboard Blocking - Profile page reuse and access control
• Admin Settings Reorganization - Tabbed settings interface

Guides

Step-by-step guides for common tasks:

• Testing Guide - How to test features
• Development Setup - Getting started with development

Planning

Project planning and roadmap:

• To-Do List - Upcoming tasks and features
• Technical Q&A - Technical decisions and answers
• Project Plan - Original project plan and vision
• Project Standards - Coding standards and conventions
• Admin Features To-Do - Admin-specific feature list
• Implementation Plan - Implementation strategy

🚀 Quick Start

1. Clone the repository

   git clone <repository-url>
   cd Tabungin
   

2. Install dependencies

   npm install
   

3. Setup environment

   cp .env.example .env
   # Edit .env with your configuration
   

4. Run development servers

   # Terminal 1: API
   cd apps/api
   npm run dev
   
   # Terminal 2: Web
   cd apps/web
   npm run dev
   

🏗️ Project Structure

Tabungin/
├── apps/
│   ├── api/          # NestJS backend
│   └── web/          # React frontend
├── docs/             # Documentation
│   ├── features/     # Feature documentation
│   ├── guides/       # How-to guides
│   └── planning/     # Project planning
└── README.md         # Project overview

🔗 Useful Links

• Main README - Project overview
• API Documentation - Backend API docs
• Web Documentation - Frontend docs

📝 Contributing

When adding new features:

1. Create feature documentation in docs/features/
2. Update testing guide if needed
3. Add to to-do list or mark as complete
4. Update this index

🆘 Need Help?

• Check the Testing Guide
• Review Technical Q&A
• See feature-specific documentation in docs/features/