Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 2.53 KB

README.md

File metadata and controls

71 lines (42 loc) · 2.53 KB
Raw

SneakyPiglet.github.io

This is the backing code for building https://SneakyPiglet.github.io/recipeDB

Get started

0. Install required applications:

<https://nodejs.org/en/>

<https://code.visualstudio.com/>

Add the following extensions to VS Code [How To?](https://code.visualstudio.com/docs/editor/extension-marketplace):

- Svelte for VS Code

1. Install the dependencies:

cd sneakypiglet-codebase
npm install

...then start Rollup:

npm run dev

Navigate to 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 we recommend installing the official extension Svelte for VS Code. 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:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

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:

"start": "sirv public --single"

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:

node scripts/setupTypeScript.js

Or remove the script via:

rm scripts/setupTypeScript.js

If you want to use baseUrl or path aliases within your tsconfig, you need to set up @rollup/plugin-alias to tell Rollup to resolve the aliases. For more info, see this StackOverflow question.