Skip to content

Commit 3fe1190

Browse files
committed
❀[DOCS] Add live demo example of Mitsuki starters
1 parent 4f04532 commit 3fe1190

File tree

3 files changed

+38
-14
lines changed

3 files changed

+38
-14
lines changed

CHANGELOG.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,23 @@ All notable changes to this project will be documented in this file.
44

55
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.1.2] - 2025-11-28
8+
9+
### Features
10+
- Refactored the CLI and project structure for a more intuitive developer experience.
11+
12+
### Documentation
13+
- Added a new "Getting Started" guide for a better onboarding experience.
14+
- Added VitePress for static-site documentation.
15+
- Updated the main README.md and benchmarks README.md files
16+
717
## [0.1.1] - 2025-11-26
818

919
### Added
1020
- `orjson` as a dependency instead of standard `json` library for Mitsuki's JSON encoder
1121
- Monkey-patch for Starlette's `init_headers` function, for the common case of JSON responses with no headers
1222

23+
[0.1.2]: https://github.com/DavidLandup0/mitsuki/releases/tag/v0.1.2
1324
[0.1.1]: https://github.com/DavidLandup0/mitsuki/releases/tag/v0.1.1
1425

1526
## [0.1.0] - 2025-11-20
@@ -34,4 +45,4 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
3445
- Support for multiple ASGI servers (Granian, Uvicorn, Socketify)
3546
- Production-ready logging and metrics
3647

37-
[0.1.0]: https://github.com/DavidLandup0/mitsuki/releases/tag/v0.1.0
48+
[0.1.0]: https://github.com/DavidLandup0/mitsuki/releases/tag/v0.1.0

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,19 +95,18 @@ This will guide you through creating a new project with a clean structure and wi
9595
```
9696
my_app/
9797
src/
98-
my_app/
99-
domain/ # @Entity classes
100-
repository/ # @CrudRepository classes
101-
service/ # @Service classes
102-
controller/ # @RestController classes
103-
__init__.py
98+
domain/ # @Entity classes
99+
repository/ # @CrudRepository classes
100+
service/ # @Service classes
101+
controller/ # @RestController classes
102+
__init__.py
104103
app.py # Application entry point
105-
application.yml # Base configuration
106-
application-dev.yml # Development configuration
107-
application-stg.yml # Staging configuration
108-
application-prod.yml # Production configuration
109-
.gitignore
110-
README.md
104+
application.yml # Base configuration
105+
application-dev.yml # Development configuration
106+
application-stg.yml # Staging configuration
107+
application-prod.yml # Production configuration
108+
.gitignore
109+
README.md
111110
```
112111

113112
Start it:
@@ -126,7 +125,7 @@ python src/app.py
126125
2025-11-20 02:04:45,960 - mitsuki - INFO - /_/ /_/ /_/_/\__/____/\__,_/_/|_/_/
127126
2025-11-20 02:04:45,960 - mitsuki - INFO - °❀˖ ° °❀⋆.ೃ࿔*:・ ° ❀˖°
128127
2025-11-20 02:04:45,960 - mitsuki - INFO -
129-
2025-11-20 02:04:45,960 - mitsuki - INFO - :: Mitsuki :: (0.1.0)
128+
2025-11-20 02:04:45,960 - mitsuki - INFO - :: Mitsuki :: (0.1.2)
130129
2025-11-20 02:04:45,960 - mitsuki - INFO -
131130
2025-11-20 02:04:45,960 - mitsuki - INFO - Mitsuki application starting on http://127.0.0.1:8000
132131
2025-11-20 02:04:45,961 - _granian - INFO - Starting granian (main PID: 19002)
@@ -140,6 +139,20 @@ And hit the docs on `http://127.0.0.1:8000/docs`:
140139

141140
![](./docs/public/doc_assets/mitsuki_init.png)
142141

142+
## Bootstrapping Projects in a Minute - from Zero to Functional Starter
143+
144+
Okay, let's go beyond "Hello World" - how long does it take to go from zero to something more functional? Something with a database connection, a domain object, a repository with CRUD capabilities, service and controller?
145+
146+
About a single minute.
147+
148+
Here's a live example, of starting a Mitsuki project, which includes:
149+
150+
- Project setup
151+
- Domain object
152+
- Entity controller, service and repository with functional CRUD
153+
154+
![](./docs/public/doc_assets/mitsuki_starter.gif)
155+
143156

144157
## Why Mitsuki?
145158

5.68 MB
Loading

0 commit comments

Comments
 (0)