https://github.com/ryu-man/svantic-template
https://github.com/ryu-man/svantic-template
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ryu-man/svantic-template
- Owner: ryu-man
- Created: 2021-02-16T09:31:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-23T21:31:24.000Z (about 5 years ago)
- Last Synced: 2025-04-03T22:44:18.061Z (over 1 year ago)
- Language: JavaScript
- Size: 1.26 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# svantic-template
This is a project template for [svelte](https://svelte.dev) apps using [svantic](https://www.github.com/ryu-man/svantic) ui library.
To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
```bash
npx degit ryu-man/svantic-template#main svantic-app
cd svantic-app
```
*Note that you will need to have [Node.js](https://nodejs.org) installed.*
## Get started
Install the dependencies...
```bash
# npm
npm install
# Yarn
yarn install
```
...then start [Rollup](https://rollupjs.org):
```bash
npm run dev
```
Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
## Building and running in production mode
To create an optimised version of the app:
```bash
npm run build
```
You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
## Using TypeScript
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
```bash
node scripts/setupTypeScript.js
```
Or remove the script via:
```bash
rm scripts/setupTypeScript.js
```