https://github.com/johnste/finicky-kickstart
Generates Finicky compatible configuration
https://github.com/johnste/finicky-kickstart
Last synced: about 1 year ago
JSON representation
Generates Finicky compatible configuration
- Host: GitHub
- URL: https://github.com/johnste/finicky-kickstart
- Owner: johnste
- License: mit
- Archived: true
- Created: 2020-05-09T09:04:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T06:57:54.000Z (over 3 years ago)
- Last Synced: 2025-03-21T08:51:17.454Z (over 1 year ago)
- Language: Svelte
- Homepage: https://finicky-kickstart.now.sh/
- Size: 263 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# Finicky Kickstart
This is a [Svelte](https://svelte.dev) app.
## Get started
Install the dependencies...
```bash
cd finicky-kickstart
yarn install
```
...then start [Rollup](https://rollupjs.org):
```bash
yarn 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).
## 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 [now](https://zeit.co/now)
Install `now` if you haven't already:
```bash
yarn install -g now
```
Then, from within your project folder:
```bash
cd public
yarn deploy --name my-project
```
As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon.
### With [surge](https://surge.sh/)
Install `surge` if you haven't already:
```bash
yarn install -g surge
```
Then, from within your project folder:
```bash
yarn run build
surge public my-project.surge.sh
```