create-zudoku 0.0.0-e64f166c → 0.0.0-e6c6bb3b

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.
Files changed (37) hide show
  1. package/LICENSE.md +12 -3
  2. package/README.md +15 -8
  3. package/dist/index.js +1 -1
  4. package/dist/templates/default/js/.env.example +2 -0
  5. package/dist/templates/default/js/README-template.md +28 -0
  6. package/dist/templates/default/js/apis/openapi.yaml +806 -0
  7. package/dist/templates/default/js/eslintrc.json +4 -0
  8. package/dist/templates/default/js/gitignore +32 -0
  9. package/dist/templates/default/js/pages/example.mdx +9 -0
  10. package/dist/templates/default/js/pages/introduction.mdx +16 -0
  11. package/dist/templates/default/js/public/logo-dark.svg +1 -0
  12. package/dist/templates/default/js/public/logo-light.svg +1 -0
  13. package/dist/templates/default/js/zudoku.config.jsx +65 -0
  14. package/dist/templates/default/ts/.env.example +2 -0
  15. package/dist/templates/default/ts/README-template.md +28 -0
  16. package/dist/templates/default/ts/apis/openapi.yaml +806 -0
  17. package/dist/templates/default/ts/eslintrc.json +6 -0
  18. package/dist/templates/default/ts/gitignore +32 -0
  19. package/dist/templates/default/ts/pages/example.mdx +9 -0
  20. package/dist/templates/default/ts/pages/introduction.mdx +16 -0
  21. package/dist/templates/default/ts/public/banner-dark.svg +100 -0
  22. package/dist/templates/default/ts/public/banner.svg +100 -0
  23. package/dist/templates/default/ts/public/logo-dark.svg +1 -0
  24. package/dist/templates/default/ts/public/logo-light.svg +1 -0
  25. package/dist/templates/default/ts/tsconfig.json +16 -0
  26. package/dist/templates/default/ts/zudoku.config.tsx +66 -0
  27. package/dist/templates/index.ts +156 -0
  28. package/dist/templates/types.ts +22 -0
  29. package/dist/templates/zuplo/README-template.md +10 -0
  30. package/dist/templates/zuplo/gitignore +32 -0
  31. package/dist/templates/zuplo/pages/introduction.mdx +153 -0
  32. package/dist/templates/zuplo/pages/markdown.mdx +108 -0
  33. package/dist/templates/zuplo/public/banner-dark.svg +100 -0
  34. package/dist/templates/zuplo/public/banner.svg +100 -0
  35. package/dist/templates/zuplo/tsconfig.json +16 -0
  36. package/dist/templates/zuplo/zudoku.config.tsx +93 -0
  37. package/package.json +2 -2
package/LICENSE.md CHANGED
@@ -2,8 +2,17 @@ The MIT License (MIT)
2
2
 
3
3
  Copyright (c) 2024 Vercel, Inc. Copyright (c) 2024 Zuplo, Inc.
4
4
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6
+ associated documentation files (the "Software"), to deal in the Software without restriction,
7
+ including without limitation the rights to use, copy, modify, merge, publish, distribute,
8
+ sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
6
10
 
7
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
11
+ The above copyright notice and this permission notice shall be included in all copies or substantial
12
+ portions of the Software.
8
13
 
9
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
15
+ NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
17
+ OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md CHANGED
@@ -16,7 +16,8 @@ pnpm create zudoku
16
16
  bunx create-zudoku
17
17
  ```
18
18
 
19
- You will be asked for the name of your project, and then whether you want to create a TypeScript project:
19
+ You will be asked for the name of your project, and then whether you want to create a TypeScript
20
+ project:
20
21
 
21
22
  ```bash
22
23
  ✔ Would you like to use TypeScript? … No / Yes
@@ -26,7 +27,8 @@ Select **Yes** to install the necessary types/dependencies and create a new TS p
26
27
 
27
28
  ### Non-interactive
28
29
 
29
- You can also pass command line arguments to set up a new project non-interactively. See `create-zudoku --help`:
30
+ You can also pass command line arguments to set up a new project non-interactively. See
31
+ `create-zudoku --help`:
30
32
 
31
33
  ```bash
32
34
  Usage: create-zudoku [project-directory] [options]
@@ -100,9 +102,14 @@ Options:
100
102
 
101
103
  ### Why use Create Zudoku App?
102
104
 
103
- `create-zudoku` allows you to create a new Zudoku app within seconds. It is officially maintained by the creators of Zudoku, and includes a number of benefits:
104
-
105
- - **Interactive Experience**: Running `npm create zudoku@latest` (with no arguments) launches an interactive experience that guides you through setting up a project.
106
- - **Zero Dependencies**: Initializing a project is as quick as one second. Create Zudoku App has zero dependencies.
107
- - **Offline Support**: Create Zudoku App will automatically detect if you're offline and bootstrap your project using your local package cache.
108
- - **Support for Examples**: Create Zudoku App can bootstrap your application using an example from the Zudoku examples collection (e.g. `npx create-zudoku --example my-docs`).
105
+ `create-zudoku` allows you to create a new Zudoku app within seconds. It is officially maintained by
106
+ the creators of Zudoku, and includes a number of benefits:
107
+
108
+ - **Interactive Experience**: Running `npm create zudoku@latest` (with no arguments) launches an
109
+ interactive experience that guides you through setting up a project.
110
+ - **Zero Dependencies**: Initializing a project is as quick as one second. Create Zudoku App has
111
+ zero dependencies.
112
+ - **Offline Support**: Create Zudoku App will automatically detect if you're offline and bootstrap
113
+ your project using your local package cache.
114
+ - **Support for Examples**: Create Zudoku App can bootstrap your application using an example from
115
+ the Zudoku examples collection (e.g. `npx create-zudoku --example my-docs`).