@ourcanopy/sapper

@ourcanopy/sapper

The next small thing in web development, powered by Svelte.

## What is Sapper?

Sapper is a framework for building high-performance universal web apps. [Read the guide](https://sapper.svelte.dev/docs) or the [introductory blog post](https://svelte.dev/blog/sapper-towards-the-ideal-web-app-framework) to learn more.


## Get started

Clone the [starter project template](https://github.com/sveltejs/sapper-template) with [degit](https://github.com/rich-harris/degit)...
When cloning you have to choose between rollup or webpack:

```bash
npx degit "sveltejs/sapper-template#rollup" my-app
# or: npx degit "sveltejs/sapper-template#webpack" my-app

...then install dependencies and start the dev server...

cd my-app
npm install
npm run dev

...and navigate to localhost:3000. To build and run in production mode:

npm run build
npm start

Development

Pull requests are encouraged and always welcome. Pick an issue and help us out!

Using in a project

npm install --save-dev @canopy/sapper

Local development

To install and work on Sapper locally:

git clone https://github.com/sveltejs/sapper.git
cd sapper
npm install
npm run dev

Linking to a Live Project

You can make changes locally to Sapper and test it against a local Sapper project. For a quick project that takes almost no setup, use the default sapper-template project. Instruction on setup are found in that project repository.

To link Sapper to your project, from the root of your local Sapper git checkout:

cd sapper
npm link

Then, to link from sapper-template (or any other given project):

cd sapper-template
npm link sapper

You should be good to test changes locally.

Running Tests

npm run test

Publishing an update

npm login // Ask to be added to @ourcanopy org
npm publish --access public

License

MIT