Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raulfdm/generate-svelte-app
A CLI to create your Svelte app.
https://github.com/raulfdm/generate-svelte-app
cli create-app scafolding svelte svelte-app sveltejs
Last synced: 10 days ago
JSON representation
A CLI to create your Svelte app.
- Host: GitHub
- URL: https://github.com/raulfdm/generate-svelte-app
- Owner: raulfdm
- License: mit
- Created: 2019-10-21T09:48:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T06:19:39.000Z (about 2 years ago)
- Last Synced: 2025-01-31T04:32:01.442Z (20 days ago)
- Topics: cli, create-app, scafolding, svelte, svelte-app, sveltejs
- Language: TypeScript
- Homepage:
- Size: 378 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Generate Svelte App
> Quick way to start your Svelte app
[](https://oclif.io)
[](https://npmjs.org/package/generate-svelte-app)
[](https://npmjs.org/package/generate-svelte-app)
[](https://github.com/raulfdm/generate-svelte-app/blob/master/package.json)# Why
The only reason this CLI exists is the fact Svelte still does not have some easy way to get started with a project like `create-react-app`, `vue-cli` or `angular-cli`.
Officially they have [this tutorial](https://svelte.dev/blog/the-easiest-way-to-get-started), which suggests using `degit` to fetch a svelte template but IMO it's still a lot of work to do.
Another thing is in this specific template their are using `sirv-cli` which for some reason has some weird bug when you start the project.
In a nutshell, this CLI is using their template with some small changes in the server to proper run locally and also starts your project running one command.
# Usage
First you have to install the CLI globally:
```bash
yarn global add generate-svelte-app
# Or if you're using Npm
# npm install generate-svelte-app --global
```Then, you can call the CLI passing your project name:
```bash
generate-svelte-app -n my-awesome-project
```It'll automatically create your project with the basic svelte files. All you need to do is start your app:
```bash
cd my-awesome-project
yarn start
```# Commands
| Command | Alias | Description | Default |
| ------- | ----- | ----------------- | ------- |
| --name | -n | Your project name | |
| --npm | | Set to use npm | yarn |# License
[MIT](./LICENSE.md)