Start with a running project and build your own business application with NocoBase Core. Work with a coding agent or follow the manual instructions. Chinese is the source language for this documentation; both editions use the same English example application and screenshots.
Getting started
- What is Core: understand the relationship between Core, templates, plugins and applications.
- Create app: create, configure and start an application, then sign in.
- Project structure: locate pages, APIs, database migrations and tests.
- Build your first app: build a complete team task application with an agent or manually, write tests, and choose a deployment method.
Developing apps
Look up application conventions by topic; prepare the corresponding data and endpoints when running an example.
- Application development overview: applications, templates, plugins and the page-to-database path.
- Develop with an agent: requirements, project guidance and verification.
- Data models and migrations: fields, relations, constraints and existing data.
- Querying and manipulating data: Repositories, pagination, relations, transactions and Query.
- Business services and HTTP APIs: services, validation, permissions and API declarations.
- Pages, routes and navigation: registration, menus, child routes and access.
- UI components and interactions: lists, forms, dialogs and feedback.
- Application configuration and system settings: runtime configuration, business settings and administration.
- Localization and themes: copy, locale resources and consistent appearance.
- Manage plugins: existing capabilities, registration, updates, removal and extension.
- Testing and acceptance: test boundaries, real data, permissions and user flows.
Deployment and operations
- Choose a deployment method: compare runtime options and prepare configuration, data, and recovery.
- Deploy with Docker: build images and run containers with persistent mounts.
- Deploy with app-installer: manage server installation, processes, and application updates.
- Deploy to Studio: manage applications, environments, and releases in Studio.
- Upgrade NocoBase Core: merge a newer template with an agent or manually, verify compatibility, and deploy the upgraded application.
- Publish an application release: rebuild and redeploy, with the update steps for each deployment method.