https://github.com/andrelmlins/svelte-scripts
Configurations and scripts for svelte applications and svelte libraries
https://github.com/andrelmlins/svelte-scripts
app build library scripts start svelte test
Last synced: 5 months ago
JSON representation
Configurations and scripts for svelte applications and svelte libraries
- Host: GitHub
- URL: https://github.com/andrelmlins/svelte-scripts
- Owner: andrelmlins
- License: mit
- Created: 2020-03-05T16:56:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T09:11:07.000Z (over 3 years ago)
- Last Synced: 2025-03-28T23:51:14.652Z (over 1 year ago)
- Topics: app, build, library, scripts, start, svelte, test
- Language: JavaScript
- Homepage:
- Size: 569 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Svelte Scripts
Configurations and scripts for svelte applications and svelte libraries
[](https://www.npmjs.com/package/svelte-scripts) • [](https://github.com/andrelmlins/svelte-scripts/blob/master/LICENSE) • [](https://travis-ci.com/andrelmlins/svelte-scripts) • [](https://david-dm.org/andrelmlins/svelte-scripts)
- Create svelte applications and libraries with zero settings.
- Configurations and scripts for svelte applications.
- Works on the most used operating systems.
## Basic Use
### For Application
Create your svelte application
```
npx degit andrelmlins/svelte-scripts/template svelte-app
cd svelte-app
yarn start
```
Then open http://localhost:5000/ to see your app.
### For Library
Create your svelte library
```
npx degit andrelmlins/svelte-scripts/template-library svelte-library
cd svelte-library
yarn start
```
Then open http://localhost:5000/ to see your library.
## Scripts
### Start the development application
Using [rollup](https://rollupjs.org/) with reference to folder `src`.
Used in applications and libraries.
```
npm start
// OR
yarn start
```
### Build the application
Using [rollup](https://rollupjs.org/) with reference to folder `src`.
Used in applications and libraries.
```
npm build
// OR
yarn build
```
### Test the project
Using [jest](https://jestjs.io/) with reference to folder `src`. Is possible edit the test config in `package.json`. Used in applications and libraries.
```
npm test
// OR
yarn test
```
## Philosophy
1. Zero settings
2. Only dependency to start a project
3. Quickly launch a svelte application
## Environment Variables
Some environment variables are available.
| Variable | Type | Default Value |
| ---------------- | ------ | ------------- |
| PORT | number | 5000 |
| HOST | string | localhost |
| PORT_LIVE_RELOAD | number | 35729 |
## Contribution guidelines
If you want to contribute to **Svelte Scripts**, be sure to review the
[contribution guidelines](CONTRIBUTING.md). This project adheres to
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
uphold this code.
## License
Svelte Scripts is open source software [licensed as MIT](https://github.com/andrelmlins/svelte-scripts/blob/master/LICENSE).