NepWalk
Welcome to the official technical documentation for the NepWalk. This platform is designed to provide seamless travel planning and booking experiences, powered by modern technologies and thoughtful design.
🌍 Overview
The Travel App is a full-stack application built to simplify travel arrangements—from discovering destinations to booking hotels, flights, and activities. This documentation serves as the central hub for understanding our system architecture, design decisions, implementation details, and future plans.
🗂️ Documentation Structure
Our documentation is organized into the following key sections:
-
Requirements
Covers business requirements (BRD, SRS), user stories, modular feature specs, UML diagrams, and quarterly planning documents. -
Architecture
High-level technical architecture, including system diagrams, data models, deployment pipelines, and design decisions. -
Design
Contains visual and UX design documentation, including wireframes, mockups, design tokens, and brand assets. -
Frontend
Details our frontend tech stack, component architecture, state management patterns, routing, and UI/UX conventions. -
Backend
Documents backend API specifications, service architecture, database schema, and core services like authentication. -
QA
Quality assurance resources including test plans, test cases, and bug tracking/reporting guidelines. -
DevOps
Covers CI/CD pipeline configuration, monitoring/alerting setups, runbooks, and incident response processes. -
Security
Internal security policies, audit logging practices, and procedures for vulnerability management. -
Release
Chronological list of release notes including version history, features added, bug fixes, and upgrade instructions.
🛠️ Technologies Used
- Frontend: Next + Tailwind CSS
- Mobile : Expo/React Native
- Backend: Django + DRF
- Documentation: MkDocs + PlantUML + Cloudflare Pages
- Version Control: GitHub (private repo)
📥 Contribution & Maintenance
This documentation is actively maintained by the Tech Everest engineering team. For internal collaboration, please refer to the GitHub repo and follow the contribution guidelines provided.