docs: add mkdocs, update links, add architecture documentation
This commit is contained in:
47
docs/content/stories/phase4/README.md
Normal file
47
docs/content/stories/phase4/README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Phase 4: Sample Feature Module (Blog)
|
||||
|
||||
## Overview
|
||||
Create a sample blog module to demonstrate the module framework. This module will implement blog posts with CRUD operations, showing how to build a feature module that integrates with the core platform.
|
||||
|
||||
## Tasks
|
||||
|
||||
### 4.1 Module Setup
|
||||
- [4.1.1 - Create Blog Module Directory](./4.1.1-create-modulesblog-directory.md)
|
||||
- [4.1.2 - Initialize Go Module](./4.1.2-initialize-gomod.md)
|
||||
|
||||
### 4.2 Module Configuration
|
||||
- [4.2.1 - Create Module Manifest](./4.2.1-create-modulesblogmoduleyaml.md)
|
||||
|
||||
### 4.3 Domain Layer
|
||||
- [4.3.1 - Create Post Domain Model](./4.3.1-create-modulesbloginternaldomainpostgo.md)
|
||||
- [4.3.2 - Create Ent Schema](./4.3.2-create-modulesbloginternalentschemapost.md)
|
||||
- [4.3.3 - Generate Ent Code](./4.3.3-generate-ent-code-for-blog-module.md)
|
||||
|
||||
### 4.4 Repository Layer
|
||||
- [4.4.1 - Create Post Repository Interface](./4.4.1-create-modulesbloginternaldomainpost_repogo.md)
|
||||
- [4.4.2 - Implement Repository](./4.4.2-implement-using-ent-client-shared-from-core.md)
|
||||
|
||||
### 4.5 Service Layer
|
||||
- [4.5.1 - Create Post Service](./4.5.1-create-modulesbloginternalservicepost_servicego.md)
|
||||
|
||||
### 4.6 API Layer
|
||||
- [4.6.1 - Create API Handler](./4.6.1-create-modulesbloginternalapihandlergo.md)
|
||||
|
||||
## Deliverables Checklist
|
||||
- [ ] Blog module directory structure created
|
||||
- [ ] Module manifest defines permissions and routes
|
||||
- [ ] Blog post domain model defined
|
||||
- [ ] Ent schema for blog posts created
|
||||
- [ ] Repository implements CRUD operations
|
||||
- [ ] Service layer implements business logic
|
||||
- [ ] API endpoints for blog posts working
|
||||
- [ ] Module integrated with core platform
|
||||
|
||||
## Acceptance Criteria
|
||||
- Blog module can be registered with core platform
|
||||
- Permissions are generated for blog module
|
||||
- CRUD operations work for blog posts
|
||||
- API endpoints require proper authentication
|
||||
- Module migrations run on startup
|
||||
- Blog posts are associated with users
|
||||
|
||||
Reference in New Issue
Block a user