ドキュメントの全体像
| セクション | 内容 | 読む場面 |
|---|---|---|
| はじめに | 基本概念、最初のアプリ、Studio での協働、学習の進め方 | NocoBase 3 を初めて使うとき |
| Core マニュアル | アプリ開発、プラグイン利用と開発、フレームワーク、デプロイ、リファレンス | 開発や保守の対象機能を調べるとき |
| Studio マニュアル | インストール、参加、タスク、プロジェクト、エージェント、品質、リリース、システム管理、リファレンス | 自分の役割に応じた操作を調べるとき |
| プロジェクトのチュートリアル | 環境とエージェントの選択、Core での開発、Studio での協働、ベストプラクティス、付録 | プロジェクトを通して順に実践するとき |
| FAQ | NocoBase 2 と 3 の違い、機能の対応、移行 | バージョン間の関係を確認するとき |
最初のハンズオンを完了する
NocoBase 3 とはで、アプリ基盤、開発のガバナンス、業務アプリの関係を理解します。
- 自分でアプリを作る場合：最初のアプリを開発するで作成、起動、顧客管理の開発を行い、役割ごとの権限を確認してから改善を続けます。
- Studio のチームに参加する場合：Studio で協働開発するへ進めます。環境が未準備なら、管理者はインストールと設定から始めます。
各ハンズオンに前提条件があり、先にすべてのマニュアルを読む必要はありません。
アプリを開発、拡張する
アプリが動いたら、アプリ開発の概要で機能の構成を理解し、プロジェクト構成でファイルを探します。開発マニュアルでは、ページと操作、サービスと API、データと権限、バックグラウンド処理、CLI、テストを扱います。
認証、ファイル、通知などはプラグイン利用、独立した保守や複数アプリでの再利用はプラグイン開発を参照します。ランタイム、コンテナ、HTTP、データベースの内部を理解したいときはフレームワークへ進みます。
Studio を利用、管理する
- メンバー：要件の提出とセッションから始め、進捗の確認、質問への回答、検収を参照します。
- プロジェクト責任者：設定、ナレッジベース、プロジェクトメモリ、進捗に続き、チェックとレビュー、リリースを参照します。
- 管理者：インストール後、エージェント、実行環境、スキル、使用量、メンバーと役割、アップグレードとバックアップを管理します。
状態、権限、エージェントの実行ルール、コマンド、設定は Studio のリファレンスにまとまっています。
プロジェクト全体を実践する
信頼できる業務システムの構築では、資産管理アプリを題材に、環境準備、設計、機器管理、申請と承認、役割、検収、デプロイを順に進めます。その後、Studio での協働、知識の蓄積、リリースを扱います。
プロジェクト全体を継続して練習したい場合に適したルートです。ハンズオンを終えている場合は、自分の経験に合う段階から読み、個別の仕組みはマニュアルで確認できます。
デプロイ、保守、詳細の参照
利用者にアプリを渡す前にデプロイ方法の選択、更新時にはアプリのリリースを読みます。データベースは互換性とデータベース設定を参照してください。