https://github.com/mj12358/svelte-template-flowbite
A template for building apps with Svelte and Flowbite.
https://github.com/mj12358/svelte-template-flowbite
flowbite flowbite-svelte svelte
Last synced: 5 days ago
JSON representation
A template for building apps with Svelte and Flowbite.
- Host: GitHub
- URL: https://github.com/mj12358/svelte-template-flowbite
- Owner: MJ12358
- Created: 2023-02-01T05:50:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T16:55:21.000Z (over 3 years ago)
- Last Synced: 2025-03-12T01:34:37.235Z (about 1 year ago)
- Topics: flowbite, flowbite-svelte, svelte
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# svelte-template-flowbite
This is a project template for [Svelte](https://svelte.dev) apps utilizing [Flowbite](https://flowbite-svelte.com/).
To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
```bash
npx degit mj12358/svelte-template-flowbite svelte-app
cd svelte-app
```
*Note that you will need to have [Node.js](https://nodejs.org) installed.*
## Get started
Install the dependencies...
```bash
cd svelte-app
npm install
```
...then start [Rollup](https://rollupjs.org):
```bash
npm run dev
```
Navigate to [localhost:8080](http://localhost:8080). 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`.
If you're using [Visual Studio Code](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.
## 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).
## Single-page app mode
By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json:
```js
"start": "sirv public --single"
```
## Deploying to the web
### With [Vercel](https://vercel.com)
Install `vercel` if you haven't already:
```bash
npm install -g vercel
```
Then, from within your project folder:
```bash
cd public
vercel deploy --name my-project
```
### With [surge](https://surge.sh/)
Install `surge` if you haven't already:
```bash
npm install -g surge
```
Then, from within your project folder:
```bash
npm run build
surge public my-project.surge.sh
```