Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agusID/boilerplate-svelte

:tada: Boilerplate Svelte Javascript Framework
https://github.com/agusID/boilerplate-svelte

boilerplate javascript storybook sveltejs webpack

Last synced: about 2 months ago
JSON representation

:tada: Boilerplate Svelte Javascript Framework

Awesome Lists containing this project

README

        

# Boilerplate Svelte

[](https://svelte.dev)
[![Travis CI](https://travis-ci.org/agusID/boilerplate-svelte.svg?branch=master)](https://travis-ci.org/agusID/boilerplate-svelte.svg?branch=master)
[![Coverage](https://img.shields.io/codeclimate/coverage/agusID/boilerplate-svelte)](https://img.shields.io/codeclimate/coverage/agusID/boilerplate-svelte?style=flat-square)
[![CodeFactor](https://www.codefactor.io/repository/github/agusid/boilerplate-svelte/badge)](https://www.codefactor.io/repository/github/agusid/boilerplate-svelte)
[![Known Vulnerabilities](https://snyk.io/test/github/agusID/boilerplate-svelte/badge.svg)](https://snyk.io/test/github/agusID/boilerplate-svelte/badge.svg)
[![Maintainability](https://api.codeclimate.com/v1/badges/4c4d867246987a1dc614/maintainability)](https://codeclimate.com/github/agusID/boilerplate-svelte/maintainability)

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)
[![Code Size](https://img.shields.io/github/languages/code-size/agusID/boilerplate-svelte)](https://img.shields.io/github/languages/code-size/agusID/boilerplate-svelte)
[![Contributor](https://img.shields.io/github/contributors/agusID/boilerplate-svelte?color=%23e67e22)](https://img.shields.io/github/contributors/agusID/boilerplate-svelte?color=%232980b9)
[![License](https://img.shields.io/github/license/agusID/boilerplate-svelte)](https://github.com/agusID/boilerplate-svelte/blob/master/LICENSE)

This is a boilerplate project for [Svelte](https://svelte.dev) apps.

To create a new project based on this boilerplate using [degit](https://github.com/Rich-Harris/degit):

```bash
npx degit agusID/boilerplate-svelte boilerplate-svelte
cd boilerplate-svelte
```

_Note that you will need to have [Node.js](https://nodejs.org) installed._

## Get started

Install the dependencies using `npm`

```bash
cd boilerplate-svelte
npm install
```

...then start webpack:

```bash
npm run dev
```

Navigate to [localhost:8080](http://localhost:8080). You should see your app running.

## Deploying to the web

### With [now](https://zeit.co/now)

Install `now` if you haven't already:

```bash
npm install -g now
```

Then, from within your project folder:

```bash
now
```

As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon.

## Guides

- [Storybook](https://github.com/agusID/boilerplate-svelte/blob/master/docs/storybook.md)
- [Svelte](https://svelte.dev/tutorial/basics)
- [Testing](https://github.com/agusID/boilerplate-svelte/blob/master/docs/testing.md)

## Contributing

Please to read the [Contributing Guidelines](https://github.com/agusID/boilerplate-svelte/blob/master/docs/contributing.md).

## Any question ?

Send message to
[email protected]


Dwi Agustianto

## License

The Boilerplate Svelte is open-sourced software licensed under the [MIT license](https://github.com/agusID/boilerplate-svelte/blob/master/LICENSE).