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: 2 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 (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T09:11:07.000Z (about 2 years ago)
• Last Synced: 2024-10-30T01:04:21.004Z (3 months ago)
• Topics: app, build, library, scripts, start, svelte, test
• Language: JavaScript
• Homepage:
• Size: 569 KB
• Stars: 3
• Watchers: 2
• 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

[![npm version](https://badge.fury.io/js/svelte-scripts.svg)](https://www.npmjs.com/package/svelte-scripts) • [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/andrelmlins/svelte-scripts/blob/master/LICENSE) • [![Build Status](https://travis-ci.com/andrelmlins/svelte-scripts.svg?branch=master)](https://travis-ci.com/andrelmlins/svelte-scripts) • [![Dependencies](https://david-dm.org/andrelmlins/svelte-scripts.svg)](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).