🎛️ Operations dashboard for LocalStore Platform - Next.js web portal for restaurant owners and staff. Menu management, sales tracking, and analytics. Powers {tenant}.localstoreplatform.com operations domains with GraphQL + real-time updates.
- Framework: Next.js 14 (App Router)
- Language: TypeScript 5
- Styling: Tailwind CSS 3
- Data Fetching: Apollo GraphQL Client
- Real-time: Socket.io client (WebSocket)
- Deployment: Vercel
- Node.js 18+
- pnpm (recommended) or npm
# Clone the repository
git clone https://github.com/localstore-platform/dashboard.git
cd dashboard
# Install dependencies
pnpm install
# Copy environment variables
cp .env.example .env.local
# Start development server
pnpm devOpen http://localhost:3000 to view the dashboard.
- Specification Links - Links to relevant specs
- Git Workflow - Branch and commit conventions
This repository implements features defined in the LocalStore Platform Specs repository.
Current Spec Version: v1.1-specs
Key specifications:
dashboard/
├── .github/ # GitHub configuration
│ ├── copilot-instructions.md
│ ├── CODEOWNERS
│ └── pull_request_template.md
├── docs/ # Documentation
│ ├── SPEC_LINKS.md
│ └── GIT_WORKFLOW.md
├── src/ # Source code (to be created)
│ ├── app/ # Next.js App Router pages
│ ├── components/ # React components
│ ├── graphql/ # GraphQL queries/mutations
│ ├── hooks/ # Custom React hooks
│ ├── lib/ # Utility functions
│ └── types/ # TypeScript types
├── .env.example # Environment variables template
├── LICENSE # AGPL-3.0 License
└── README.md # This file
- Primary Locale: Vietnamese (vi-VN)
- Currency: VND (e.g., 75.000₫)
- Target Market: Vietnamese small businesses (restaurants, street food vendors)
- Follow the Git Workflow guidelines
- Create a feature branch from
main - Make changes following the spec
- Submit a PR using the template
This project is licensed under the AGPL-3.0 License.