create-soda 0.1.0 → 0.2.0
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 +13 -3
- package/dist/index.js +1418 -100
- package/package.json +6 -4
- package/templates/minimal/README.md +14 -0
- package/templates/minimal/_gitignore +11 -0
- package/templates/minimal/package.json +19 -0
- package/templates/minimal/src/app.controller.ts +12 -0
- package/templates/minimal/src/app.module.ts +6 -0
- package/templates/minimal/src/app.service.ts +5 -0
- package/templates/minimal/src/app.test.ts +15 -0
- package/templates/minimal/src/main.ts +7 -0
- package/templates/minimal/tsconfig.json +19 -0
- package/core-version.json +0 -1
- package/dist/project.js +0 -68
- /package/{template → templates/demo}/README.md +0 -0
- /package/{template → templates/demo}/_gitignore +0 -0
- /package/{template → templates/demo}/package.json +0 -0
- /package/{template → templates/demo}/src/app.module.ts +0 -0
- /package/{template → templates/demo}/src/auth/auth.guard.ts +0 -0
- /package/{template → templates/demo}/src/main.ts +0 -0
- /package/{template → templates/demo}/src/users/users.controller.ts +0 -0
- /package/{template → templates/demo}/src/users/users.module.ts +0 -0
- /package/{template → templates/demo}/src/users/users.service.ts +0 -0
- /package/{template → templates/demo}/src/users/users.test.ts +0 -0
- /package/{template → templates/demo}/tsconfig.json +0 -0
package/README.md
CHANGED
|
@@ -6,25 +6,35 @@ Creates a [Soda](https://github.com/getsodajs/soda) project.
|
|
|
6
6
|
bun create soda my-app
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
or `npm create soda@latest my-app`.
|
|
9
|
+
or `npm create soda@latest my-app`. In a terminal it asks for the directory, the template and whether to install dependencies; then:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
cd my-app
|
|
13
|
-
bun install
|
|
14
13
|
bun dev
|
|
15
14
|
```
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
## Templates
|
|
17
|
+
|
|
18
|
+
| Template | |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `minimal` | a module, a controller, a service and a test; the default |
|
|
21
|
+
| `demo` | users with validation, a guard passing the current user to handlers, logging, CORS and graceful shutdown |
|
|
18
22
|
|
|
19
23
|
## Options
|
|
20
24
|
|
|
21
25
|
| Option | |
|
|
22
26
|
|---|---|
|
|
23
27
|
| `[directory]` | where to create the project; asked in a terminal, `soda-app` otherwise |
|
|
28
|
+
| `-t, --template <name>` | template to use; asked in a terminal, `minimal` otherwise |
|
|
29
|
+
| `--install`, `--no-install` | install dependencies; asked in a terminal, not installed otherwise |
|
|
24
30
|
| `--overwrite` | empty a non-empty directory first (`.git` is kept) |
|
|
25
31
|
| `--no-interactive` | never ask, for scripts and CI |
|
|
26
32
|
| `--core-version <range>` | version of `@getsoda/core` to depend on |
|
|
27
33
|
|
|
34
|
+
```bash
|
|
35
|
+
bun create soda my-app --template demo --install --no-interactive
|
|
36
|
+
```
|
|
37
|
+
|
|
28
38
|
## License
|
|
29
39
|
|
|
30
40
|
[MIT](./LICENSE)
|