@oaysus/cli 0.1.11 → 0.1.13
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 -52
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,22 +1,63 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://oaysus.com">
|
|
3
|
+
<img src="https://oaysus.com/images/oaysus-icon.png" alt="Oaysus Logo" width="80" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<h1 align="center">Oaysus CLI</h1>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<strong>The visual page builder for developer-built components</strong>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
<p align="center">
|
|
14
|
+
Build components in React, Vue, or Svelte. Push with one command.<br />
|
|
15
|
+
Let your team create pages visually.
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
<a href="https://oaysus.com/docs/quickstart"><strong>Documentation</strong></a> ·
|
|
20
|
+
<a href="https://youtu.be/VlUNf-uZvTY"><strong>Watch Demo</strong></a> ·
|
|
21
|
+
<a href="https://oaysus.com"><strong>Website</strong></a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
<p align="center">
|
|
25
|
+
<a href="https://github.com/oaysus/cli/stargazers">
|
|
26
|
+
<img src="https://img.shields.io/github/stars/oaysus/cli?style=social" alt="GitHub stars" />
|
|
27
|
+
</a>
|
|
28
|
+
|
|
29
|
+
<a href="https://www.npmjs.com/package/@oaysus/cli">
|
|
30
|
+
<img src="https://img.shields.io/npm/v/@oaysus/cli.svg" alt="npm version" />
|
|
31
|
+
</a>
|
|
32
|
+
<a href="https://opensource.org/licenses/MIT">
|
|
33
|
+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" />
|
|
34
|
+
</a>
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
<p align="center">
|
|
38
|
+
<sub>If you find Oaysus useful, please consider giving us a ⭐ on GitHub!</sub>
|
|
39
|
+
</p>
|
|
40
|
+
|
|
41
|
+
<p align="center">
|
|
42
|
+
<a href="https://youtu.be/VlUNf-uZvTY">
|
|
43
|
+
<img src="./assets/demo.gif" alt="Oaysus CLI Demo" width="800" />
|
|
44
|
+
</a>
|
|
45
|
+
<br />
|
|
46
|
+
<sub>From code to published page in seconds</sub>
|
|
47
|
+
</p>
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## One command. Your component is live.
|
|
52
|
+
|
|
53
|
+
Watch how fast you can go from code to a published website with Oaysus.
|
|
2
54
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
**Build components in React, Vue, or Svelte. Push with one command. Let your team create pages visually.**
|
|
7
|
-
|
|
8
|
-
Stop building every landing page from scratch. Oaysus lets developers create reusable components that marketing teams can assemble into pages without writing code or waiting for deployments.
|
|
9
|
-
|
|
10
|
-
## What is Oaysus?
|
|
11
|
-
|
|
12
|
-
[Oaysus](https://oaysus.com) is a visual page builder for developer-built components. You write components in your favorite framework, define what's editable via a simple schema, and push them to Oaysus. Your marketing team then uses a drag-and-drop editor to create pages instantly.
|
|
13
|
-
|
|
14
|
-
**The workflow:**
|
|
15
|
-
```
|
|
16
|
-
Developer builds component → Pushes to Oaysus → Marketing creates pages visually
|
|
55
|
+
```bash
|
|
56
|
+
oaysus init # Pick your framework. Name your project.
|
|
57
|
+
oaysus push # Your component builds and deploys in seconds.
|
|
17
58
|
```
|
|
18
59
|
|
|
19
|
-
No
|
|
60
|
+
No build pipelines. No complex deployments. Your marketing team creates pages visually, and you get back to building features.
|
|
20
61
|
|
|
21
62
|
## Installation
|
|
22
63
|
|
|
@@ -53,19 +94,6 @@ That's it. Your components are now available in the visual page builder.
|
|
|
53
94
|
Install in dashboard: Content → Theme Packs
|
|
54
95
|
```
|
|
55
96
|
|
|
56
|
-
## Commands
|
|
57
|
-
|
|
58
|
-
| Command | Description |
|
|
59
|
-
|---------|-------------|
|
|
60
|
-
| `oaysus init [name]` | Create a new theme pack project |
|
|
61
|
-
| `oaysus create` | Add a component to your project |
|
|
62
|
-
| `oaysus validate` | Validate package structure |
|
|
63
|
-
| `oaysus build` | Build components locally (no upload) |
|
|
64
|
-
| `oaysus push` | Build and upload to Oaysus |
|
|
65
|
-
| `oaysus login` | Authenticate with Oaysus |
|
|
66
|
-
| `oaysus logout` | Clear authentication |
|
|
67
|
-
| `oaysus whoami` | Display current user |
|
|
68
|
-
|
|
69
97
|
## Framework Support
|
|
70
98
|
|
|
71
99
|
Build with the tools you already know:
|
|
@@ -82,11 +110,15 @@ Each component has two files: the code and a schema that defines what's editable
|
|
|
82
110
|
|
|
83
111
|
**Component (React example):**
|
|
84
112
|
```tsx
|
|
85
|
-
export default function
|
|
113
|
+
export default function Hero({ headline, subtext, ctaLabel }) {
|
|
86
114
|
return (
|
|
87
|
-
<
|
|
88
|
-
{
|
|
89
|
-
|
|
115
|
+
<section className="py-20 text-center">
|
|
116
|
+
<h1 className="text-5xl font-bold">{headline}</h1>
|
|
117
|
+
<p className="mt-4 text-xl text-gray-600">{subtext}</p>
|
|
118
|
+
<button className="mt-8 px-6 py-3 bg-blue-600 text-white rounded-lg">
|
|
119
|
+
{ctaLabel}
|
|
120
|
+
</button>
|
|
121
|
+
</section>
|
|
90
122
|
);
|
|
91
123
|
}
|
|
92
124
|
```
|
|
@@ -94,21 +126,38 @@ export default function AnnouncementBar({ message, backgroundColor }) {
|
|
|
94
126
|
**Schema:**
|
|
95
127
|
```json
|
|
96
128
|
{
|
|
97
|
-
"displayName": "
|
|
129
|
+
"displayName": "Hero Section",
|
|
98
130
|
"props": {
|
|
99
|
-
"
|
|
131
|
+
"headline": {
|
|
100
132
|
"type": "string",
|
|
101
|
-
"default": "
|
|
133
|
+
"default": "Build faster, ship sooner"
|
|
102
134
|
},
|
|
103
|
-
"
|
|
104
|
-
"type": "
|
|
105
|
-
"default": "
|
|
135
|
+
"subtext": {
|
|
136
|
+
"type": "string",
|
|
137
|
+
"default": "The platform for modern teams"
|
|
138
|
+
},
|
|
139
|
+
"ctaLabel": {
|
|
140
|
+
"type": "string",
|
|
141
|
+
"default": "Get Started"
|
|
106
142
|
}
|
|
107
143
|
}
|
|
108
144
|
}
|
|
109
145
|
```
|
|
110
146
|
|
|
111
|
-
Marketing edits
|
|
147
|
+
Marketing edits these props in the visual editor. You never touch the code again.
|
|
148
|
+
|
|
149
|
+
## Commands
|
|
150
|
+
|
|
151
|
+
| Command | Description |
|
|
152
|
+
|---------|-------------|
|
|
153
|
+
| `oaysus init [name]` | Create a new theme pack project |
|
|
154
|
+
| `oaysus create` | Add a component to your project |
|
|
155
|
+
| `oaysus validate` | Validate package structure |
|
|
156
|
+
| `oaysus build` | Build components locally (no upload) |
|
|
157
|
+
| `oaysus push` | Build and upload to Oaysus |
|
|
158
|
+
| `oaysus login` | Authenticate with Oaysus |
|
|
159
|
+
| `oaysus logout` | Clear authentication |
|
|
160
|
+
| `oaysus whoami` | Display current user |
|
|
112
161
|
|
|
113
162
|
## Project Structure
|
|
114
163
|
|
|
@@ -116,33 +165,33 @@ Marketing edits `message` and `backgroundColor` in the visual editor. You never
|
|
|
116
165
|
my-components/
|
|
117
166
|
├── package.json
|
|
118
167
|
└── components/
|
|
119
|
-
├──
|
|
168
|
+
├── Hero/
|
|
120
169
|
│ ├── index.tsx
|
|
121
170
|
│ └── schema.json
|
|
122
|
-
├──
|
|
171
|
+
├── FeatureGrid/
|
|
123
172
|
│ ├── index.tsx
|
|
124
173
|
│ └── schema.json
|
|
125
|
-
└──
|
|
174
|
+
└── Testimonials/
|
|
126
175
|
├── index.tsx
|
|
127
176
|
└── schema.json
|
|
128
177
|
```
|
|
129
178
|
|
|
130
|
-
## Documentation
|
|
131
|
-
|
|
132
|
-
- **[Quick Start Guide](https://oaysus.com/docs/quickstart)** — Build your first component in 5 minutes
|
|
133
|
-
- **[CLI Reference](https://oaysus.com/docs/cli)** — Complete command documentation
|
|
134
|
-
- **[Component Guide](https://oaysus.com/docs/components)** — Props, schemas, and best practices
|
|
135
|
-
- **[Theme Packs](https://oaysus.com/docs/theme-packs)** — Organize and distribute component collections
|
|
136
|
-
|
|
137
179
|
## Why Oaysus?
|
|
138
180
|
|
|
139
181
|
| Traditional Approach | With Oaysus |
|
|
140
182
|
|---------------------|-------------|
|
|
141
183
|
| Marketing files a ticket for every page change | Marketing creates pages themselves |
|
|
142
184
|
| Developers build one-off landing pages | Developers build reusable components |
|
|
143
|
-
| Every text change requires a deploy | Changes publish instantly |
|
|
185
|
+
| Every text change requires a deploy | Changes publish instantly to global CDN |
|
|
144
186
|
| Locked into proprietary CMS themes | Standard React/Vue/Svelte you own |
|
|
145
187
|
|
|
188
|
+
## Documentation
|
|
189
|
+
|
|
190
|
+
- **[Quick Start Guide](https://oaysus.com/docs/quickstart)** — Build your first component in 5 minutes
|
|
191
|
+
- **[CLI Reference](https://oaysus.com/docs/cli)** — Complete command documentation
|
|
192
|
+
- **[Component Guide](https://oaysus.com/docs/components)** — Props, schemas, and best practices
|
|
193
|
+
- **[Theme Packs](https://oaysus.com/docs/theme-packs)** — Organize and distribute component collections
|
|
194
|
+
|
|
146
195
|
## Get Started
|
|
147
196
|
|
|
148
197
|
1. **[Create an account](https://oaysus.com/pricing)** — Free tier available
|
|
@@ -155,4 +204,4 @@ We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for development
|
|
|
155
204
|
|
|
156
205
|
## License
|
|
157
206
|
|
|
158
|
-
MIT
|
|
207
|
+
MIT © [Oaysus](https://oaysus.com)
|