rapidkit 0.16.3 → 0.16.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -33
- package/dist/index.js +206 -195
- package/dist/package.json +3 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -536,68 +536,103 @@ The registry stores workspace and project metadata:
|
|
|
536
536
|
|
|
537
537
|
## 📁 Project Structure
|
|
538
538
|
|
|
539
|
+
### Workspace
|
|
540
|
+
|
|
541
|
+
```
|
|
542
|
+
my-workspace/
|
|
543
|
+
├── my-api/ # FastAPI project
|
|
544
|
+
│ ├── .rapidkit/ # Project config
|
|
545
|
+
│ ├── src/ # Source code
|
|
546
|
+
│ ├── config/ # Configuration
|
|
547
|
+
│ ├── tests/ # Test suite
|
|
548
|
+
│ ├── pyproject.toml # Poetry config
|
|
549
|
+
│ └── Dockerfile # Docker setup
|
|
550
|
+
├── my-service/ # NestJS project
|
|
551
|
+
│ ├── .rapidkit/ # Project config
|
|
552
|
+
│ ├── src/ # Source code
|
|
553
|
+
│ ├── test/ # Test suite
|
|
554
|
+
│ ├── package.json # npm config
|
|
555
|
+
│ └── Dockerfile # Docker setup
|
|
556
|
+
├── .venv/ # Workspace Python environment
|
|
557
|
+
├── .rapidkit-workspace # Workspace metadata
|
|
558
|
+
├── poetry.lock # Locked Python dependencies
|
|
559
|
+
├── pyproject.toml # Workspace Python config
|
|
560
|
+
├── rapidkit # CLI script (bash)
|
|
561
|
+
├── rapidkit.cmd # CLI script (Windows)
|
|
562
|
+
├── README.md
|
|
563
|
+
└── Makefile
|
|
564
|
+
```
|
|
565
|
+
|
|
539
566
|
### FastAPI Project
|
|
540
567
|
|
|
541
568
|
```
|
|
542
569
|
my-api/
|
|
543
|
-
├── .rapidkit/
|
|
544
|
-
│ ├──
|
|
545
|
-
│ ├──
|
|
546
|
-
│ ├──
|
|
547
|
-
│ └──
|
|
548
|
-
├──
|
|
549
|
-
├──
|
|
550
|
-
│ ├──
|
|
551
|
-
│ ├── cli.py # CLI commands
|
|
552
|
-
│ ├── routing/ # API routes
|
|
570
|
+
├── .rapidkit/ # RapidKit config
|
|
571
|
+
│ ├── project.json # Project metadata
|
|
572
|
+
│ ├── context.json # Project context
|
|
573
|
+
│ ├── cli.py # Local CLI module
|
|
574
|
+
│ └── activate # Environment activation
|
|
575
|
+
├── src/ # Source code
|
|
576
|
+
│ ├── main.py # FastAPI entry point
|
|
577
|
+
│ ├── routing/ # API routes
|
|
553
578
|
│ │ ├── __init__.py
|
|
554
579
|
│ │ ├── health.py
|
|
555
580
|
│ │ └── examples.py
|
|
556
|
-
│ └── modules/
|
|
581
|
+
│ └── modules/ # Feature modules
|
|
557
582
|
│ └── __init__.py
|
|
558
|
-
├──
|
|
583
|
+
├── config/ # Configuration
|
|
584
|
+
├── tests/ # Test suite
|
|
559
585
|
│ ├── __init__.py
|
|
560
586
|
│ ├── test_health.py
|
|
561
587
|
│ └── test_examples.py
|
|
562
|
-
├──
|
|
563
|
-
├──
|
|
564
|
-
├── Dockerfile # Docker configuration
|
|
565
|
-
├── docker-compose.yml # Docker Compose
|
|
566
|
-
├── .env.example # Environment template
|
|
588
|
+
├── .github/ # GitHub workflows
|
|
589
|
+
├── .env.example # Environment template
|
|
567
590
|
├── .gitignore
|
|
591
|
+
├── bootstrap.sh # Setup script
|
|
592
|
+
├── docker-compose.yml # Docker Compose
|
|
593
|
+
├── Dockerfile # Docker configuration
|
|
594
|
+
├── Makefile # Make commands
|
|
595
|
+
├── poetry.lock # Locked dependencies
|
|
596
|
+
├── pyproject.toml # Poetry configuration
|
|
597
|
+
├── LICENSE
|
|
568
598
|
└── README.md
|
|
569
599
|
```
|
|
570
600
|
|
|
571
601
|
### NestJS Project
|
|
572
602
|
|
|
573
603
|
```
|
|
574
|
-
my-
|
|
575
|
-
├── .rapidkit/
|
|
576
|
-
│ ├──
|
|
577
|
-
│ ├──
|
|
578
|
-
│ └──
|
|
579
|
-
├──
|
|
580
|
-
├──
|
|
581
|
-
│ ├── main.ts # Application entry point
|
|
604
|
+
my-app/
|
|
605
|
+
├── .rapidkit/ # RapidKit config
|
|
606
|
+
│ ├── project.json # Project metadata
|
|
607
|
+
│ ├── context.json # Project context
|
|
608
|
+
│ └── cli.js # Local CLI module (optional)
|
|
609
|
+
├── src/ # Source code
|
|
610
|
+
│ ├── main.ts # NestJS entry point
|
|
582
611
|
│ ├── app.module.ts # Root module
|
|
583
612
|
│ ├── app.controller.ts # Root controller
|
|
584
613
|
│ ├── app.service.ts # Root service
|
|
585
|
-
│ ├── config/ # Configuration
|
|
614
|
+
│ ├── config/ # Configuration module
|
|
586
615
|
│ │ ├── configuration.ts
|
|
587
616
|
│ │ └── validation.ts
|
|
588
|
-
│ └── examples/ # Example module
|
|
617
|
+
│ └── examples/ # Example CRUD module
|
|
589
618
|
│ ├── examples.module.ts
|
|
590
619
|
│ ├── examples.controller.ts
|
|
591
620
|
│ └── examples.service.ts
|
|
592
|
-
├── test/ # Test
|
|
621
|
+
├── test/ # Test suite
|
|
593
622
|
│ ├── app.e2e-spec.ts
|
|
594
623
|
│ └── jest-e2e.json
|
|
595
|
-
├──
|
|
596
|
-
├── tsconfig.json # TypeScript config
|
|
597
|
-
├── nest-cli.json # NestJS CLI config
|
|
598
|
-
├── Dockerfile # Docker configuration
|
|
599
|
-
├── docker-compose.yml # Docker Compose
|
|
624
|
+
├── .github/ # GitHub workflows
|
|
600
625
|
├── .env.example # Environment template
|
|
626
|
+
├── .gitignore
|
|
627
|
+
├── bootstrap.sh # Setup script
|
|
628
|
+
├── docker-compose.yml # Docker Compose
|
|
629
|
+
├── Dockerfile # Docker configuration
|
|
630
|
+
├── eslint.config.cjs # ESLint configuration
|
|
631
|
+
├── jest.config.ts # Jest configuration
|
|
632
|
+
├── nest-cli.json # NestJS CLI config
|
|
633
|
+
├── package.json # npm dependencies
|
|
634
|
+
├── tsconfig.json # TypeScript config
|
|
635
|
+
├── LICENSE
|
|
601
636
|
└── README.md
|
|
602
637
|
```
|
|
603
638
|
|