# Home

> The Dev Guide home page, the development guide for our developers.

## Welcome to Dev Guide

Dev Guide is the shared reference for our developers building web, mobile, and other products. It is where the team can find agreed ways of working, from interface design to the technology choices on each platform.

The goal is for every project to start from the same foundation, for new developers to get up to speed faster, and for technical decisions not to be debated again each time.

## What's inside

| Section                               | Scope                                                                                                                                                 |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Style Guide](https://dev-guide.nusapalagroup.com/style-guide/overview.md)           | Design tokens, foundation, components, templates, and the UI review checklist                                                                         |
| [Engineering Practices](https://dev-guide.nusapalagroup.com/engineering/overview.md) | Workflow (Git, pull requests, decisions), building (API design, config, security, observability, testing), and shipping (CI/CD, production readiness) |
| [Environments](https://dev-guide.nusapalagroup.com/environments/overview.md)         | Local, dev, staging, UAT, and production: tiers, naming, local development, data, promotion, and go-live                                              |
| [Web Frontend](https://dev-guide.nusapalagroup.com/frontend/overview.md)             | React project structure, data (fetch, TanStack Query, Zod), pages and UI, tooling, and production                                                     |
| [Web Backend](https://dev-guide.nusapalagroup.com/backend/overview.md)               | Clean architecture, transport (HTTP, gRPC), data (PostgreSQL, sqlc, Redis), the API Gateway, and Auth Services                                        |
| [Fullstack](https://dev-guide.nusapalagroup.com/fullstack/overview.md)               | Next.js on Bun, Bun + Turborepo + React, Astro, and Drizzle                                                                                           |
| [Mobile](https://dev-guide.nusapalagroup.com/mobile/overview.md)                     | Flutter project structure, building blocks (state, network, navigation, theme, Firebase), and release                                                 |

Every section starts with an **Overview** and a **Tech Stack** page, so you can see what a project
uses and how to use it, and ends with a **Production Checklist** that every release passes.

## Where to start

| If you are working on                               | Read                                                                                                             |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Web interfaces                                      | [Style Guide](https://dev-guide.nusapalagroup.com/style-guide/overview.md), then [Web Frontend](https://dev-guide.nusapalagroup.com/frontend/overview.md)                                                      |
| Any project, on any platform                        | [Engineering Practices](https://dev-guide.nusapalagroup.com/engineering/overview.md)                                                                            |
| Running, testing, and releasing in each environment | [Environments](https://dev-guide.nusapalagroup.com/environments/overview.md)                                                                                    |
| A service that must ship fast, or a content site    | [Fullstack](https://dev-guide.nusapalagroup.com/fullstack/overview.md)                                                                                          |
| A release going to production                       | The Production Checklist of the platform, and [Production Readiness](https://dev-guide.nusapalagroup.com/engineering/shipping/production-readiness.md) |
| APIs and backend services                           | [Web Backend](https://dev-guide.nusapalagroup.com/backend/overview.md), then [API Design](https://dev-guide.nusapalagroup.com/engineering/building/api-design.md)                                     |
| Web apps from server to client                      | [Style Guide](https://dev-guide.nusapalagroup.com/style-guide/overview.md), then [Fullstack](https://dev-guide.nusapalagroup.com/fullstack/overview.md)                                                        |
| Mobile apps                                         | [Style Guide](https://dev-guide.nusapalagroup.com/style-guide/overview.md), then [Mobile](https://dev-guide.nusapalagroup.com/mobile/overview.md)                                                              |

The **Search** box in the header, or **⌘K** on a Mac and **Ctrl+K** elsewhere, looks through page titles,
descriptions, and page bodies. Arrow keys move through the results, Enter opens one, and Escape closes it.

## Coming next

This guide will grow with the team's needs, for example with guides for ESP32 edge devices based on ESP-IDF and for computer vision.

## Contributing

Found a mistake or want to add a guide? See how to write and add pages in
[How to Contribute](https://dev-guide.nusapalagroup.com/contribute/how-to-contribute.md), and who maintains each area in
[Contributors](https://dev-guide.nusapalagroup.com/contribute/contributors.md).

---

NBA Development Guide. Check [llms.txt](https://dev-guide.nusapalagroup.com/llms.txt) to see the other documentation.