Skip to content

Commit 72dadcd

Browse files
authored
Merge pull request #24 from BearStudio/feat/typescript
2 parents fe43714 + f2c82a1 commit 72dadcd

35 files changed

+2544
-3168
lines changed

.eslintrc.json

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/workflows/build.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Build
2+
3+
on:
4+
- push
5+
6+
jobs:
7+
cache-and-install:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v4
13+
14+
- uses: pnpm/action-setup@v4
15+
name: Install pnpm
16+
with:
17+
version: 10
18+
run_install: false
19+
20+
- name: Install Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 22
24+
cache: 'pnpm'
25+
26+
- name: Install dependencies
27+
run: pnpm install
28+
29+
- name: Build cli
30+
run: pnpm build

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ assets/img/.DS_Store
7171
# VSCode related files #
7272
# .vscode
7373

74-
.eslintcache
74+
dist/

.husky/pre-commit

Lines changed: 0 additions & 4 deletions
This file was deleted.

.husky/pre-push

Lines changed: 0 additions & 4 deletions
This file was deleted.

.prettierignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

.prettierrc.json

Lines changed: 0 additions & 12 deletions
This file was deleted.

.vscode/extensions.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["biomejs.biome"]
3+
}

README.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,45 @@
44

55
Generate a 🚀 Start UI project in a new folder.
66

7-
```bash
8-
yarn create start-ui --web [projectName] # Generate a start-ui-web project
9-
yarn create start-ui --native [projectName] # Generate a start-ui-native project
7+
```sh
8+
pnpm create start-ui <projectName> # Generate a start-ui-web project
9+
pnpm create start-ui -t native <projectName> # Generate a start-ui-native project
1010
```
1111

1212
## Options
1313

14-
```
15-
-h, --help Show this help
16-
-v, --version Display CLI version
17-
--web PROJECT_PATH Scaffold a brand new StartUI [Web] project
18-
--native PROJECT_PATH Scaffold a brand new StartUI [Native] project
19-
--branch BRANCH_NAME Specify the git branch used to clone the project
20-
--no-git-init Ignore `git init` step
21-
--no-package-install Ignore node packages install step
22-
```
23-
24-
## Examples
14+
```sh
15+
Usage: create-start-ui [options] <appName>
2516

26-
```bash
27-
# Create a new web project
28-
yarn create start-ui --web my-web-project
17+
Arguments:
18+
appName Name of the app to create
2919

30-
# Skip git repo initialization
31-
yarn create start-ui --web --no-git-init my-web-project
20+
Options:
21+
-b, --branch <branch> Specify a branch you want to use to start
22+
-t, --type <type> Type of app you want to create
23+
--skip-install Skip node modules installation step (default: false)
24+
--skip-git-init Skip git init step (default: false)
25+
--verbose Add additional details if something goes wrong (default: false)
26+
-V, --version output the version number
27+
-h, --help display help for command
3228
```
3329
3430
## Development
3531
3632
1. Link the repository to your system with the following command:
3733
38-
```bash
39-
yarn link
34+
```sh
35+
pnpm link-cli
4036
```
4137
42-
2. Test your local package in any directory:
38+
2. Run dev command to have the cli be rebuilt on each save:
4339
44-
```bash
45-
yarn create start-ui --web [projectName]
40+
```sh
41+
pnpm dev
4642
```
4743
48-
3. After testing, remove the linked repository:
44+
3. Run the cli in any directory, it will reflect any changes you have made:
4945
50-
```bash
51-
yarn unlink
46+
```sh
47+
create-start-ui myApp
5248
```

app/config/cli.js

Lines changed: 0 additions & 92 deletions
This file was deleted.

app/debug.js

Lines changed: 0 additions & 5 deletions
This file was deleted.

app/functions.js

Lines changed: 0 additions & 110 deletions
This file was deleted.

0 commit comments

Comments
 (0)