https://github.com/manuel3108/sapper-smui-template

The default Sapper template using webpack, with included support for SMUI
https://github.com/manuel3108/sapper-smui-template

sapper sapper-template svelte-material-ui

Last synced: about 1 month ago
JSON representation

The default Sapper template using webpack, with included support for SMUI

• Host: GitHub
• URL: https://github.com/manuel3108/sapper-smui-template
• Owner: manuel3108
• License: apache-2.0
• Created: 2019-11-28T16:54:56.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T12:16:18.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T21:17:59.557Z (over 1 year ago)
• Topics: sapper, sapper-template, svelte-material-ui
• Language: JavaScript
• Homepage:
• Size: 990 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sapper-smui-template

The default [Sapper](https://github.com/sveltejs/sapper) template using webpack, with included support for [SMUI](https://github.com/hperrin/svelte-material-ui).

If you don't want Typescript support, have a look at [sapper-smui-typescript-template](https://github.com/manuel3108/sapper-smui-typescript-template)

## Getting started

### Using `degit`

[`degit`](https://github.com/Rich-Harris/degit) is a scaffolding tool that lets you create a directory from a branch in a repository. Use either the `rollup` or `webpack` branch in `sapper-template`:

```bash

npx degit "manuel3108/sapper-smui-template" my-app

```

### Using GitHub templates

Alternatively, you can use GitHub's template feature with this repository.

### Running the project

Running the app is as usual:

```bash

cd my-app

npm install # or yarn

npm run dev

```

Open up [localhost:3000](http://localhost:3000) and start clicking around.

## Usage

At the moment, you will get a standard sapper app created with 

```bash

npx degit "sveltejs/sapper-template#webpack" my-app

```

and one additional SMUI Button. As explained in the SMUI repository it is recommended to install each component on its own. So currently you will only be able to use buttons.

If you want to install further components, just do

```bash

npm install --save-dev @smui/component-name

```

**Be sure to add `--save-dev` or `-D` to add those components as dev-Dependencies. They will not work if you install them as normal dependencies.**