phos 1.0.0 → 1.0.2

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 (97) hide show
  1. package/README.md +68 -42
  2. package/dist/cli.js +351 -171
  3. package/dist/cli.js.map +1 -1
  4. package/dist/generators/backends/elysia.d.ts +1 -1
  5. package/dist/generators/backends/elysia.d.ts.map +1 -1
  6. package/dist/generators/backends/elysia.js +22 -127
  7. package/dist/generators/backends/elysia.js.map +1 -1
  8. package/dist/generators/backends/fastapi.d.ts +1 -1
  9. package/dist/generators/backends/fastapi.d.ts.map +1 -1
  10. package/dist/generators/backends/fastapi.js +40 -148
  11. package/dist/generators/backends/fastapi.js.map +1 -1
  12. package/dist/generators/frontends/astro.d.ts +1 -1
  13. package/dist/generators/frontends/astro.d.ts.map +1 -1
  14. package/dist/generators/frontends/astro.js +17 -295
  15. package/dist/generators/frontends/astro.js.map +1 -1
  16. package/dist/generators/frontends/nextjs.d.ts +1 -1
  17. package/dist/generators/frontends/nextjs.d.ts.map +1 -1
  18. package/dist/generators/frontends/nextjs.js +17 -266
  19. package/dist/generators/frontends/nextjs.js.map +1 -1
  20. package/dist/generators/frontends/svelte.d.ts +1 -1
  21. package/dist/generators/frontends/svelte.d.ts.map +1 -1
  22. package/dist/generators/frontends/svelte.js +18 -316
  23. package/dist/generators/frontends/svelte.js.map +1 -1
  24. package/dist/generators/monorepo.d.ts +1 -1
  25. package/dist/generators/monorepo.d.ts.map +1 -1
  26. package/dist/generators/monorepo.js +369 -202
  27. package/dist/generators/monorepo.js.map +1 -1
  28. package/dist/generators/single.d.ts +1 -1
  29. package/dist/generators/single.d.ts.map +1 -1
  30. package/dist/generators/single.js +335 -134
  31. package/dist/generators/single.js.map +1 -1
  32. package/dist/templates/backend/elysia/src/api/user_api.d.ts +1 -0
  33. package/dist/templates/backend/elysia/src/api/user_api.d.ts.map +1 -0
  34. package/dist/templates/backend/elysia/src/api/user_api.js +2 -0
  35. package/dist/templates/backend/elysia/src/api/user_api.js.map +1 -0
  36. package/dist/templates/backend/elysia/src/db.d.ts +3 -0
  37. package/dist/templates/backend/elysia/src/db.d.ts.map +1 -0
  38. package/dist/templates/backend/elysia/src/db.js +13 -0
  39. package/dist/templates/backend/elysia/src/db.js.map +1 -0
  40. package/dist/templates/backend/elysia/src/index.d.ts +4 -0
  41. package/dist/templates/backend/elysia/src/index.d.ts.map +1 -0
  42. package/dist/templates/backend/elysia/src/index.js +55 -0
  43. package/dist/templates/backend/elysia/src/index.js.map +1 -0
  44. package/dist/templates/backend/elysia/src/service/user_service.d.ts +1 -0
  45. package/dist/templates/backend/elysia/src/service/user_service.d.ts.map +1 -0
  46. package/dist/templates/backend/elysia/src/service/user_service.js +2 -0
  47. package/dist/templates/backend/elysia/src/service/user_service.js.map +1 -0
  48. package/dist/templates/backend/elysia/src/sql/user_sql.d.ts +1 -0
  49. package/dist/templates/backend/elysia/src/sql/user_sql.d.ts.map +1 -0
  50. package/dist/templates/backend/elysia/src/sql/user_sql.js +2 -0
  51. package/dist/templates/backend/elysia/src/sql/user_sql.js.map +1 -0
  52. package/dist/templates/backend/elysia/src/types/user_type.d.ts +1 -0
  53. package/dist/templates/backend/elysia/src/types/user_type.d.ts.map +1 -0
  54. package/dist/templates/backend/elysia/src/types/user_type.js +2 -0
  55. package/dist/templates/backend/elysia/src/types/user_type.js.map +1 -0
  56. package/dist/templates/frontend/nextjs/app/layout.d.ts +7 -0
  57. package/dist/templates/frontend/nextjs/app/layout.d.ts.map +1 -0
  58. package/dist/templates/frontend/nextjs/app/layout.js +22 -0
  59. package/dist/templates/frontend/nextjs/app/layout.js.map +1 -0
  60. package/dist/templates/frontend/nextjs/app/page.d.ts +2 -0
  61. package/dist/templates/frontend/nextjs/app/page.d.ts.map +1 -0
  62. package/dist/templates/frontend/nextjs/app/page.js +15 -0
  63. package/dist/templates/frontend/nextjs/app/page.js.map +1 -0
  64. package/dist/templates/frontend/nextjs/next.config.d.ts +4 -0
  65. package/dist/templates/frontend/nextjs/next.config.d.ts.map +1 -0
  66. package/dist/templates/frontend/nextjs/next.config.js +5 -0
  67. package/dist/templates/frontend/nextjs/next.config.js.map +1 -0
  68. package/dist/templates/frontend/svelte/src/lib/index.d.ts +1 -0
  69. package/dist/templates/frontend/svelte/src/lib/index.d.ts.map +1 -0
  70. package/dist/templates/frontend/svelte/src/lib/index.js +3 -0
  71. package/dist/templates/frontend/svelte/src/lib/index.js.map +1 -0
  72. package/dist/templates/frontend/svelte/vite.config.d.ts +3 -0
  73. package/dist/templates/frontend/svelte/vite.config.d.ts.map +1 -0
  74. package/dist/templates/frontend/svelte/vite.config.js +5 -0
  75. package/dist/templates/frontend/svelte/vite.config.js.map +1 -0
  76. package/dist/utils/helpers.d.ts +10 -10
  77. package/dist/utils/helpers.d.ts.map +1 -1
  78. package/dist/utils/helpers.js +77 -34
  79. package/dist/utils/helpers.js.map +1 -1
  80. package/package.json +7 -2
  81. package/src/templates/frontend/astro/.vscode/extensions.json +4 -0
  82. package/src/templates/frontend/astro/.vscode/launch.json +11 -0
  83. package/src/templates/frontend/svelte/.vscode/settings.json +5 -0
  84. package/.eslintignore +0 -3
  85. package/AGENTS.md +0 -172
  86. package/CHANGELOG.md +0 -184
  87. package/bun.lock +0 -125
  88. package/src/cli.ts +0 -500
  89. package/src/generators/backends/elysia.ts +0 -45
  90. package/src/generators/backends/fastapi.ts +0 -71
  91. package/src/generators/frontends/astro.ts +0 -37
  92. package/src/generators/frontends/nextjs.ts +0 -37
  93. package/src/generators/frontends/svelte.ts +0 -38
  94. package/src/generators/monorepo.ts +0 -529
  95. package/src/generators/single.ts +0 -465
  96. package/src/utils/helpers.ts +0 -198
  97. package/tsconfig.json +0 -24
package/README.md CHANGED
@@ -5,11 +5,14 @@
5
5
  Full-stack interactive project generator CLI
6
6
 
7
7
  [![npm version](https://badge.fury.io/js/phos.svg)](https://www.npmjs.com/package/phos)
8
+ [![Downloads](https://img.shields.io/npm/dm/phos)](https://www.npmjs.com/package/phos)
8
9
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
10
  [![Node.js Version](https://img.shields.io/node/v/phos)](https://nodejs.org)
10
11
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
11
12
 
12
- **Version 1.0.0 - Production Release** 🎉
13
+ **Version 1.0.2 - Production Release** 🎉
14
+
15
+ [View on npmjs.com](https://www.npmjs.com/package/phos)
13
16
 
14
17
  </div>
15
18
 
@@ -35,11 +38,52 @@ Phos is a powerful CLI tool that scaffolds modern full-stack web applications wi
35
38
  - 🎯 Single project mode for standalone applications
36
39
  - 📚 Comprehensive documentation auto-generation
37
40
 
41
+ ## Tech Stack
42
+
43
+ ### Core
44
+
45
+ <div align="center">
46
+
47
+ | Technology | Description | Version |
48
+ | ------------------------------------------------------------------------------------------------------------------- | -------------------- | ------- |
49
+ | ![Node.js](https://img.shields.io/badge/Node.js-20+-43853D?style=flat-square&logo=node.js&logoColor=white) | Runtime Environment | 20+ |
50
+ | ![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178C6?style=flat-square&logo=typescript&logoColor=white) | Programming Language | 5.7+ |
51
+ | ![Commander.js](https://img.shields.io/badge/Commander.js-14.0-000000?style=flat-square) | CLI Framework | 14.0+ |
52
+ | ![Clack](https://img.shields.io/badge/@clack/prompts-1.0-8B5CF6?style=flat-square) | Interactive Prompts | 1.0+ |
53
+ | ![fs-extra](https://img.shields.io/badge/fs--extra-11.3-0288D1?style=flat-square) | File Operations | 11.3+ |
54
+ | ![Handlebars](https://img.shields.io/badge/Handlebars-4.7-F0772E?style=flat-square) | Template Engine | 4.7+ |
55
+ | ![Picocolors](https://img.shields.io/badge/Picocolors-1.1-E67E22?style=flat-square) | Terminal Colors | 1.1+ |
56
+
57
+ </div>
58
+
59
+ ### Supported Frameworks
60
+
61
+ #### Backend
62
+
63
+ | Framework | Runtime | Description |
64
+ | ---------------------------------------- | ------- | ---------------------------------- |
65
+ | [Elysia](https://elysiajs.com/) | Bun | Fast and elegant Bun web framework |
66
+ | [FastAPI](https://fastapi.tiangolo.com/) | Python | Modern Python web framework |
67
+
68
+ #### Frontend
69
+
70
+ | Framework | Description |
71
+ | ------------------------------------ | -------------------------------------- |
72
+ | [Astro](https://astro.build/) | Modern static site generator |
73
+ | [SvelteKit](https://kit.svelte.dev/) | Full-stack Svelte framework |
74
+ | [Next.js](https://nextjs.org/) | React framework with server components |
75
+
38
76
  ## Quick Start
39
77
 
40
- ```bash
41
- bun create phos
42
- ```
78
+ <div align="center">
79
+
80
+ ### Choose Your Package Manager
81
+
82
+ | npm | yarn | bun |
83
+ | ----------------- | ---------------------- | ------------------ |
84
+ | `npx phos create` | `yarn dlx phos create` | `bunx phos create` |
85
+
86
+ </div>
43
87
 
44
88
  Follow the interactive prompts to configure your project, and Phos will generate a production-ready scaffold in seconds.
45
89
 
@@ -47,16 +91,25 @@ Follow the interactive prompts to configure your project, and Phos will generate
47
91
 
48
92
  ### From NPM
49
93
 
94
+ <div align="center">
95
+
96
+ ```bash
97
+ npx phos create
98
+ ```
99
+
100
+ </div>
101
+
102
+ #### Alternative Package Managers
103
+
50
104
  ```bash
51
- bun create phos
52
- npm create phos
53
- yarn create phos
105
+ bunx phos create
106
+ yarn dlx phos create
54
107
  ```
55
108
 
56
109
  ### Local Development
57
110
 
58
111
  ```bash
59
- git clone <repository-url>
112
+ git clone https://github.com/DotJumpDot/Phos.git
60
113
  cd phos
61
114
  bun install
62
115
  bun link
@@ -121,34 +174,6 @@ my-project/
121
174
  └── README.md # Project documentation
122
175
  ```
123
176
 
124
- ## Tech Stack
125
-
126
- ### Core
127
-
128
- - **Runtime**: Node.js + TypeScript
129
- - **CLI Framework**: Commander.js
130
- - **Interactive Prompts**: @clack/prompts
131
- - **File Operations**: fs-extra
132
- - **Template Engine**: Handlebars
133
- - **Colors**: picocolors
134
-
135
- ### Supported Frameworks
136
-
137
- #### Backend
138
-
139
- | Framework | Runtime | Description |
140
- | ---------------------------------------- | ------- | ---------------------------------- |
141
- | [Elysia](https://elysiajs.com/) | Bun | Fast and elegant Bun web framework |
142
- | [FastAPI](https://fastapi.tiangolo.com/) | Python | Modern Python web framework |
143
-
144
- #### Frontend
145
-
146
- | Framework | Description |
147
- | ------------------------------------ | -------------------------------------- |
148
- | [Astro](https://astro.build/) | Modern static site generator |
149
- | [SvelteKit](https://kit.svelte.dev/) | Full-stack Svelte framework |
150
- | [Next.js](https://nextjs.org/) | React framework with server components |
151
-
152
177
  ## Development
153
178
 
154
179
  ```bash
@@ -158,7 +183,7 @@ bun install
158
183
  # Run in development mode
159
184
  bun run dev create
160
185
 
161
- # Build the project
186
+ # Build project
162
187
  bun run build
163
188
 
164
189
  # Run the built CLI
@@ -170,7 +195,7 @@ node dist/cli.js create
170
195
  ### Create a Monorepo with Elysia and Next.js
171
196
 
172
197
  ```bash
173
- phos create
198
+ npx phos create
174
199
  # Project name: my-awesome-app
175
200
  # Project type: Monorepo
176
201
  # Backend Framework: Elysia
@@ -193,7 +218,7 @@ phos create
193
218
  ### Create a Single Astro Project
194
219
 
195
220
  ```bash
196
- phos create
221
+ bunx phos create
197
222
  # Project name: my-astro-site
198
223
  # Project type: Single repo
199
224
  # Framework: Astro
@@ -243,7 +268,7 @@ phos create
243
268
 
244
269
  Contributions are welcome! Please feel free to submit a Pull Request.
245
270
 
246
- 1. Fork the repository
271
+ 1. Fork repository
247
272
  2. Create your feature branch (`git checkout -b feature/amazing-feature`)
248
273
  3. Commit your changes (`git commit -m 'Add some amazing feature'`)
249
274
  4. Push to the branch (`git push origin feature/amazing-feature`)
@@ -253,8 +278,9 @@ Contributions are welcome! Please feel free to submit a Pull Request.
253
278
 
254
279
  Phos follows [semantic versioning](https://semver.org/).
255
280
 
281
+ - **1.0.2** - Patch release (template missing fix)
282
+ - **1.0.1** - Patch release (bug fixes)
256
283
  - **1.0.0** - Production release with full feature support
257
- - **1.0.x** - Patch releases (bug fixes, documentation)
258
284
  - **1.x.0** - Minor releases (new features, non-breaking changes)
259
285
  - **x.0.0** - Major releases (breaking changes)
260
286
 
@@ -274,6 +300,6 @@ See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
274
300
 
275
301
  <div align="center">
276
302
 
277
- Made with ❤️ by the DotJumpDot
303
+ Made with ❤️ by the Phos Team
278
304
 
279
305
  </div>