create-akan-workspace 2.1.0 → 2.1.1-rc.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.
Files changed (3) hide show
  1. package/README.md +102 -0
  2. package/index.js +9 -9
  3. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,102 @@
1
+ # 🚀 Create Akan Workspace
2
+
3
+ The quickest way to bootstrap a new Akan.js workspace with a single command. This package provides a streamlined entry point that automatically installs the Akan.js CLI and creates your workspace in one step.
4
+
5
+ ## ⚡ Get Started
6
+
7
+ The fastest way to create a new Akan.js workspace:
8
+
9
+ ```bash
10
+ bunx create-akan-workspace
11
+ ```
12
+
13
+ That's it! This single command will:
14
+
15
+ 1. Install the latest `akanjs` globally
16
+ 2. Run the interactive workspace creation wizard
17
+ 3. Set up your development environment
18
+
19
+ ### Quick Setup Examples
20
+
21
+ ```bash
22
+ # Interactive mode (recommended)
23
+ bunx create-akan-workspace
24
+
25
+ # Specify organization name
26
+ bunx create-akan-workspace "my-company"
27
+
28
+ # Full setup with options
29
+ bunx create-akan-workspace "my-company" --app "web-app" --dir "./projects"
30
+ ```
31
+
32
+ ## 📋 Options
33
+
34
+ | Option | Description | Example |
35
+ | ------------------ | ------------------------------ | ------------------ |
36
+ | `[org]` | Organization name (positional) | `my-company` |
37
+ | `-a, --app <name>` | Initial application name | `--app web-app` |
38
+ | `-d, --dir <path>` | Target directory | `--dir ./projects` |
39
+
40
+ ## 🎯 What Happens Next
41
+
42
+ After running `create-akan-workspace`, you'll have:
43
+
44
+ 1. **✅ Akan.js CLI installed globally** - Access to all `akan` commands
45
+ 2. **🏗️ Workspace created** - Organized project structure
46
+ 3. **📱 Initial application** - Ready-to-run starter app
47
+ 4. **🔧 Development environment** - Configured tooling and dependencies
48
+
49
+ ### Start developing immediately:
50
+
51
+ ```bash
52
+ cd <workspace-name>
53
+ akan start <app-name> --open
54
+ ```
55
+
56
+ Navigate to http://localhost:4200 to see your app running!
57
+
58
+ ## 🛠️ Requirements
59
+
60
+ - **Bun.js** >=1.3
61
+
62
+ ## 🔗 What's Next?
63
+
64
+ After creating your workspace, explore the full power of Akan.js CLI:
65
+
66
+ ```bash
67
+ # AI-powered module creation
68
+ akan create-module
69
+
70
+ # Set up AI assistant
71
+ akan set-llm
72
+
73
+ # Build for production
74
+ akan build <app-name>
75
+ ```
76
+
77
+ ## 📚 Learn More
78
+
79
+ - [`akanjs`](../akanjs) - Full CLI documentation and features
80
+ - [Akan.js Documentation](https://docs.akanjs.com) - Complete development guide
81
+ - [Examples](https://github.com/akan-team/examples) - Sample projects and tutorials
82
+
83
+ ## 🤝 Contributing
84
+
85
+ This package is part of the Akan.js ecosystem. Contributions are welcome!
86
+
87
+ 1. Fork the repository
88
+ 2. Create your feature branch
89
+ 3. Commit your changes
90
+ 4. Push to the branch
91
+ 5. Open a Pull Request
92
+
93
+ ## 📄 License
94
+
95
+ This project is part of the Akan.js ecosystem. See the main repository for license information.
96
+
97
+ ---
98
+
99
+ <p align="center">
100
+ <strong>Built with ❤️ by the Akan.js team</strong><br>
101
+ <em></em>
102
+ </p>
package/index.js CHANGED
@@ -33,7 +33,7 @@ var __toESM = (mod, isNodeMode, target) => {
33
33
  var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
34
34
  var __require = import.meta.require;
35
35
 
36
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/error.js
36
+ // node_modules/commander/lib/error.js
37
37
  var require_error = __commonJS((exports) => {
38
38
  class CommanderError extends Error {
39
39
  constructor(exitCode, code, message) {
@@ -57,7 +57,7 @@ var require_error = __commonJS((exports) => {
57
57
  exports.InvalidArgumentError = InvalidArgumentError;
58
58
  });
59
59
 
60
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/argument.js
60
+ // node_modules/commander/lib/argument.js
61
61
  var require_argument = __commonJS((exports) => {
62
62
  var { InvalidArgumentError } = require_error();
63
63
 
@@ -137,7 +137,7 @@ var require_argument = __commonJS((exports) => {
137
137
  exports.humanReadableArgName = humanReadableArgName;
138
138
  });
139
139
 
140
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/help.js
140
+ // node_modules/commander/lib/help.js
141
141
  var require_help = __commonJS((exports) => {
142
142
  var { humanReadableArgName } = require_argument();
143
143
 
@@ -494,7 +494,7 @@ ${itemIndentStr}`);
494
494
  exports.stripColor = stripColor;
495
495
  });
496
496
 
497
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/option.js
497
+ // node_modules/commander/lib/option.js
498
498
  var require_option = __commonJS((exports) => {
499
499
  var { InvalidArgumentError } = require_error();
500
500
 
@@ -678,7 +678,7 @@ var require_option = __commonJS((exports) => {
678
678
  exports.DualOptions = DualOptions;
679
679
  });
680
680
 
681
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/suggestSimilar.js
681
+ // node_modules/commander/lib/suggestSimilar.js
682
682
  var require_suggestSimilar = __commonJS((exports) => {
683
683
  var maxDistance = 3;
684
684
  function editDistance(a, b) {
@@ -751,7 +751,7 @@ var require_suggestSimilar = __commonJS((exports) => {
751
751
  exports.suggestSimilar = suggestSimilar;
752
752
  });
753
753
 
754
- // node_modules/.bun/commander@14.0.3/node_modules/commander/lib/command.js
754
+ // node_modules/commander/lib/command.js
755
755
  var require_command = __commonJS((exports) => {
756
756
  var EventEmitter = __require("events").EventEmitter;
757
757
  var childProcess = __require("child_process");
@@ -1005,7 +1005,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
1005
1005
  this._exitCallback = (err) => {
1006
1006
  if (err.code !== "commander.executeSubCommandAsync") {
1007
1007
  throw err;
1008
- } else {}
1008
+ }
1009
1009
  };
1010
1010
  }
1011
1011
  return this;
@@ -2106,7 +2106,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
2106
2106
  exports.useColor = useColor;
2107
2107
  });
2108
2108
 
2109
- // node_modules/.bun/commander@14.0.3/node_modules/commander/index.js
2109
+ // node_modules/commander/index.js
2110
2110
  var require_commander = __commonJS((exports) => {
2111
2111
  var { Argument } = require_argument();
2112
2112
  var { Command } = require_command();
@@ -2129,7 +2129,7 @@ var require_commander = __commonJS((exports) => {
2129
2129
  // pkgs/create-akan-workspace/run.ts
2130
2130
  import { spawn } from "child_process";
2131
2131
 
2132
- // node_modules/.bun/commander@14.0.3/node_modules/commander/esm.mjs
2132
+ // node_modules/commander/esm.mjs
2133
2133
  var import__ = __toESM(require_commander(), 1);
2134
2134
  var {
2135
2135
  program,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "sourceType": "module",
3
3
  "name": "create-akan-workspace",
4
- "version": "2.1.0",
4
+ "version": "2.1.1-rc.0",
5
5
  "bin": {
6
6
  "create-akan-workspace": "index.js"
7
7
  },