create-foldkit-app 0.5.5 → 0.5.7
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 +36 -0
- package/dist/commands/create.js +12 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# create-foldkit-app
|
|
2
|
+
|
|
3
|
+
Scaffolding CLI for new Foldkit applications. Creates a ready-to-run project with Vite, Tailwind CSS, TypeScript, [`@foldkit/vite-plugin`](https://www.npmjs.com/package/@foldkit/vite-plugin) for hot reloading with Model preservation, and your choice of starter example.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx create-foldkit-app --wizard
|
|
9
|
+
# or
|
|
10
|
+
pnpm create foldkit-app --wizard
|
|
11
|
+
# or
|
|
12
|
+
yarn create foldkit-app --wizard
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The CLI will prompt you for a project name, starter example, and package manager.
|
|
16
|
+
|
|
17
|
+
## Examples
|
|
18
|
+
|
|
19
|
+
| Example | Description |
|
|
20
|
+
| ---------------- | --------------------------------------------------------------- |
|
|
21
|
+
| `counter` | Simple increment/decrement with reset |
|
|
22
|
+
| `stopwatch` | Timer with start/stop/reset |
|
|
23
|
+
| `weather` | HTTP requests with async state handling |
|
|
24
|
+
| `todo` | CRUD operations with localStorage persistence |
|
|
25
|
+
| `form` | Form validation with async email checking |
|
|
26
|
+
| `snake` | Classic game built with Subscriptions |
|
|
27
|
+
| `routing` | URL routing with parser combinators and route parameters |
|
|
28
|
+
| `query-sync` | URL-driven filtering, sorting, and search |
|
|
29
|
+
| `shopping-cart` | Complex state management with nested Models |
|
|
30
|
+
| `websocket-chat` | Managed resources with WebSocket |
|
|
31
|
+
| `auth` | Authentication with Submodels, OutMessage, and protected routes |
|
|
32
|
+
| `ui-showcase` | Every Foldkit UI component with routing |
|
|
33
|
+
|
|
34
|
+
## License
|
|
35
|
+
|
|
36
|
+
MIT
|
package/dist/commands/create.js
CHANGED
|
@@ -32,6 +32,16 @@ const displaySuccessMessage = (name, packageManager) => Effect.gen(function* ()
|
|
|
32
32
|
yield* Console.log(` ${chalk.cyan('cd')} ${name}`);
|
|
33
33
|
yield* Console.log(` ${chalk.cyan(runDevServerCommand(packageManager))}`);
|
|
34
34
|
yield* Console.log('');
|
|
35
|
+
yield* Console.log(chalk.bold('AI-assisted development'));
|
|
36
|
+
yield* Console.log('');
|
|
37
|
+
yield* Console.log('Clone Foldkit as a submodule so your AI assistant can\n' +
|
|
38
|
+
'reference the source, examples, and documentation:');
|
|
39
|
+
yield* Console.log('');
|
|
40
|
+
yield* Console.log(` ${chalk.cyan('cd')} ${name}`);
|
|
41
|
+
yield* Console.log(` ${chalk.cyan('git submodule add https://github.com/foldkit/foldkit.git repos/foldkit')}`);
|
|
42
|
+
yield* Console.log('');
|
|
43
|
+
yield* Console.log(`Details: ${chalk.cyan('foldkit.dev/ai/overview')}`);
|
|
44
|
+
yield* Console.log('');
|
|
35
45
|
yield* Console.log('Foldkit is a one-astronaut nights-and-weekends project.\n' +
|
|
36
46
|
'If you have praise or criticism, do share.\n' +
|
|
37
47
|
"Please. It's lonely out here.\n\n" +
|
|
@@ -40,12 +50,14 @@ const displaySuccessMessage = (name, packageManager) => Effect.gen(function* ()
|
|
|
40
50
|
yield* Console.log(`Training manual: ${chalk.cyan('foldkit.dev')}`);
|
|
41
51
|
yield* Console.log(`Incident report: ${chalk.cyan('github.com/foldkit/foldkit/issues')}`);
|
|
42
52
|
yield* Console.log('');
|
|
53
|
+
yield* Console.log(`Transmissions: ${chalk.cyan('foldkit.dev/newsletter')}`);
|
|
43
54
|
yield* Console.log(`X: ${chalk.cyan('x.com/devinjameson')}`);
|
|
44
55
|
yield* Console.log(`Bluesky: ${chalk.cyan('bsky.app/profile/devinjameson.bsky.social')}`);
|
|
45
56
|
yield* Console.log(`Threads: ${chalk.cyan('threads.com/@devinthedeveloper')}`);
|
|
46
57
|
yield* Console.log('');
|
|
47
58
|
yield* Console.log('Love you,');
|
|
48
59
|
yield* Console.log('Mission Control');
|
|
60
|
+
yield* Console.log('');
|
|
49
61
|
});
|
|
50
62
|
export const create = ({ name, example, packageManager }) => Effect.gen(function* () {
|
|
51
63
|
const path = yield* Path.Path;
|