create-akan-workspace 0.0.141 → 0.0.142
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 +101 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,106 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 🚀 Create Akan Workspace
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The quickest way to bootstrap a new AkanJS workspace with a single command. This package provides a streamlined entry point that automatically installs the AkanJS CLI and creates your workspace in one step.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## ⚡ Get Started
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The fastest way to create a new AkanJS workspace:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
```bash
|
|
10
|
+
npx create-akan-workspace
|
|
11
|
+
```
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
That's it! This single command will:
|
|
14
|
+
|
|
15
|
+
1. Install the latest `@akanjs/cli` 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
|
+
npx create-akan-workspace
|
|
24
|
+
|
|
25
|
+
# Specify organization name
|
|
26
|
+
npx create-akan-workspace "my-company"
|
|
27
|
+
|
|
28
|
+
# Full setup with options
|
|
29
|
+
npx 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. **✅ AkanJS 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
|
+
- **Node.js** >=22.x
|
|
61
|
+
- **npm** or **yarn** or **pnpm**
|
|
62
|
+
|
|
63
|
+
## 🔗 What's Next?
|
|
64
|
+
|
|
65
|
+
After creating your workspace, explore the full power of AkanJS CLI:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# AI-powered module creation
|
|
69
|
+
akan create-module
|
|
70
|
+
|
|
71
|
+
# Set up AI assistant
|
|
72
|
+
akan set-llm
|
|
73
|
+
|
|
74
|
+
# Build for production
|
|
75
|
+
akan build <app-name>
|
|
76
|
+
|
|
77
|
+
# Deploy to cloud
|
|
78
|
+
akan deploy-akan
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## 📚 Learn More
|
|
82
|
+
|
|
83
|
+
- [`@akanjs/cli`](../cli) - Full CLI documentation and features
|
|
84
|
+
- [AkanJS Documentation](https://docs.akanjs.com) - Complete development guide
|
|
85
|
+
- [Examples](https://github.com/akan-team/examples) - Sample projects and tutorials
|
|
86
|
+
|
|
87
|
+
## 🤝 Contributing
|
|
88
|
+
|
|
89
|
+
This package is part of the AkanJS ecosystem. Contributions are welcome!
|
|
90
|
+
|
|
91
|
+
1. Fork the repository
|
|
92
|
+
2. Create your feature branch
|
|
93
|
+
3. Commit your changes
|
|
94
|
+
4. Push to the branch
|
|
95
|
+
5. Open a Pull Request
|
|
96
|
+
|
|
97
|
+
## 📄 License
|
|
98
|
+
|
|
99
|
+
This project is part of the AkanJS ecosystem. See the main repository for license information.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
<p align="center">
|
|
104
|
+
<strong>Built with ❤️ by the AkanJS team</strong><br>
|
|
105
|
+
<em></em>
|
|
106
|
+
</p>
|