https://github.com/bearstudio/create-start-ui
Create a 🚀 Start UI project
https://github.com/bearstudio/create-start-ui
startui startui-native startui-web
Last synced: about 1 year ago
JSON representation
Create a 🚀 Start UI project
- Host: GitHub
- URL: https://github.com/bearstudio/create-start-ui
- Owner: BearStudio
- License: mit
- Created: 2021-08-30T11:40:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-21T13:05:37.000Z (about 1 year ago)
- Last Synced: 2025-06-09T04:58:16.908Z (about 1 year ago)
- Topics: startui, startui-native, startui-web
- Language: TypeScript
- Homepage:
- Size: 321 KB
- Stars: 25
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create a 🚀 Start UI project
## Usage
Generate a 🚀 Start UI project in a new folder.
```bash
yarn create start-ui --web [projectName] # Generate a start-ui-web project
yarn create start-ui --native [projectName] # Generate a start-ui-native project
```
## Options
```
-h, --help Show this help
-v, --version Display CLI version
--web PROJECT_PATH Scaffold a brand new StartUI [Web] project
--native PROJECT_PATH Scaffold a brand new StartUI [Native] project
--branch BRANCH_NAME Specify the git branch used to clone the project
--no-git-init Ignore `git init` step
--no-package-install Ignore node packages install step
```
## Examples
```bash
# Create a new web project
yarn create start-ui --web my-web-project
# Skip git repo initialization
yarn create start-ui --web --no-git-init my-web-project
```
## Development
1. Link the repository to your system with the following command:
```bash
yarn link
```
2. Test your local package in any directory:
```bash
yarn create start-ui --web [projectName]
```
3. After testing, remove the linked repository:
```bash
yarn unlink
```