A command-line tool for quickly setting up a new project with Sea JS using Vite.
- Quickly create a new project with a predefined setup.
- Automatically generates
package.json
with the latest versions ofsea-js-ui-core
andvite
. - Includes a customizable template for initial project setup.
You can use the CLI without installing it globally by running:
npx create-sea-app <project-name>
To install the CLI globally:
npm install -g create-sea-app
After installation, you can use the CLI to create a new project:
create-sea-app <project-name>
Replace <project-name>
with the desired name of your project. This command will:
- Create a new directory named
<project-name>
. - Copy the template files into the new directory.
- Generate a
package.json
file with the latest versions ofsea-js-ui-core
andvite
.
To create a project named my-app
, run:
create-sea-app my-app
Navigate to the project directory and install the dependencies:
cd my-app
npm install
Start the development server:
npm start
The CLI generates a basic project setup with the following configuration:
package.json
: Includes scripts for starting, building, and serving the app.- Vite as the build tool.
sea-js-ui-core
as a core dependency.
The CLI uses a default template located in the templates
directory. You can customize this template as needed.
To develop or contribute to the CLI:
-
Clone the repository:
git clone <repository-url>
-
Navigate to the project directory:
cd create-sea-app
-
Install dependencies:
npm install
-
Make changes to the source code in the
src
directory. -
Link the CLI globally for testing:
npm link
-
Test the CLI:
create-sea-app <project-name>
Contributions are welcome! Please open an issue or submit a pull request with your changes.
This CLI is licensed under the MIT License.
- Vite - The build tool used in this project.