|
1 | | -# unspecified.io |
| 1 | +# create-svelte |
2 | 2 |
|
3 | | -## Running the project |
| 3 | +Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte); |
4 | 4 |
|
5 | | -However you get the code, you can install dependencies and run the project in development mode with: |
| 5 | +## Creating a project |
6 | 6 |
|
7 | | -```bash |
8 | | -cd my-app |
9 | | -npm install # or yarn |
10 | | -npm run dev |
11 | | -``` |
12 | | - |
13 | | -Open up [localhost:3000](http://localhost:3000) and start clicking around. |
14 | | - |
15 | | -Consult [sapper.svelte.dev](https://sapper.svelte.dev) for help getting started. |
16 | | - |
17 | | -## Structure |
18 | | - |
19 | | -Sapper expects to find two directories in the root of your project — `src` and `static`. |
20 | | - |
21 | | -### src |
22 | | - |
23 | | -The [src](src) directory contains the entry points for your app — `client.js`, `server.js` and (optionally) a `service-worker.js` — along with a `template.html` file and a `routes` directory. |
24 | | - |
25 | | -#### src/routes |
26 | | - |
27 | | -This is the heart of your Sapper app. There are two kinds of routes — _pages_, and _server routes_. |
28 | | - |
29 | | -**Pages** are Svelte components written in `.svelte` files. When a user first visits the application, they will be served a server-rendered version of the route in question, plus some JavaScript that 'hydrates' the page and initialises a client-side router. From that point forward, navigating to other pages is handled entirely on the client for a fast, app-like feel. (Sapper will preload and cache the code for these subsequent pages, so that navigation is instantaneous.) |
30 | | - |
31 | | -**Server routes** are modules written in `.js` files, that export functions corresponding to HTTP methods. Each function receives Express `request` and `response` objects as arguments, plus a `next` function. This is useful for creating a JSON API, for example. |
| 7 | +If you're seeing this, you've probably already done this step. Congrats! |
32 | 8 |
|
33 | | -There are three simple rules for naming the files that define your routes: |
34 | | - |
35 | | -- A file called `src/routes/about.svelte` corresponds to the `/about` route. A file called `src/routes/blog/[slug].svelte` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route |
36 | | -- The file `src/routes/index.svelte` (or `src/routes/index.js`) corresponds to the root of your app. `src/routes/about/index.svelte` is treated the same as `src/routes/about.svelte`. |
37 | | -- Files and directories with a leading underscore do _not_ create routes. This allows you to colocate helper modules and components with the routes that depend on them — for example you could have a file called `src/routes/_helpers/datetime.js` and it would _not_ create a `/_helpers/datetime` route |
38 | | - |
39 | | -### static |
40 | | - |
41 | | -The [static](static) directory contains any static assets that should be available. These are served using [sirv](https://github.com/lukeed/sirv). |
42 | | - |
43 | | -In your [service-worker.js](src/service-worker.js) file, you can import these as `files` from the generated manifest... |
| 9 | +```bash |
| 10 | +# create a new project in the current directory |
| 11 | +npm init svelte@next |
44 | 12 |
|
45 | | -```js |
46 | | -import { files } from "@sapper/service-worker"; |
| 13 | +# create a new project in my-app |
| 14 | +npm init svelte@next my-app |
47 | 15 | ``` |
48 | 16 |
|
49 | | -...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files). |
50 | | - |
51 | | -## Bundler config |
| 17 | +> Note: the `@next` is temporary |
52 | 18 |
|
53 | | -Sapper uses Rollup or webpack to provide code-splitting and dynamic imports, as well as compiling your Svelte components. With webpack, it also provides hot module reloading. As long as you don't do anything daft, you can edit the configuration files to add whatever plugins you'd like. |
| 19 | +## Developing |
54 | 20 |
|
55 | | -## Production mode and deployment |
56 | | - |
57 | | -To start a production version of your app, run `npm run build && npm start`. This will disable live reloading, and activate the appropriate bundler plugins. |
58 | | - |
59 | | -You can deploy your application to any environment that supports Node 8 or above. As an example, to deploy to [Now](https://zeit.co/now), run these commands: |
| 21 | +Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: |
60 | 22 |
|
61 | 23 | ```bash |
62 | | -npm install -g now |
63 | | -now |
| 24 | +npm run dev |
| 25 | + |
| 26 | +# or start the server and open the app in a new browser tab |
| 27 | +npm run dev -- --open |
64 | 28 | ``` |
65 | 29 |
|
66 | | -## Using external components |
| 30 | +## Building |
67 | 31 |
|
68 | | -When using Svelte components installed from npm, such as [@sveltejs/svelte-virtual-list](https://github.com/sveltejs/svelte-virtual-list), Svelte needs the original component source (rather than any precompiled JavaScript that ships with the component). This allows the component to be rendered server-side, and also keeps your client-side app smaller. |
| 32 | +Svelte apps are built with _adapters_, which optimise your project for deployment to different environments, like [Begin](https://begin.com), [Netlify](https://www.netlify.com), [Vercel](https://vercel.com) and so on. (You can also create your own adapter — instructions TODO.) |
69 | 33 |
|
70 | | -Because of that, it's essential that the bundler doesn't treat the package as an _external dependency_. You can either modify the `external` option under `server` in [rollup.config.js](rollup.config.js) or the `externals` option in [webpack.config.js](webpack.config.js), or simply install the package to `devDependencies` rather than `dependencies`, which will cause it to get bundled (and therefore compiled) with your app: |
| 34 | +By default, `npm run build` will generate a Node app that you can run with `node build`. To use a different adapter, install it and update your `svelte.config.cjs` accordingly. The following official adapters are available: |
71 | 35 |
|
72 | | -```bash |
73 | | -npm install -D @sveltejs/svelte-virtual-list |
74 | | -``` |
| 36 | +- [@sveltejs/adapter-node](https://github.com/sveltejs/kit/tree/master/packages/adapter-node) |
| 37 | +- [@sveltejs/adapter-static](https://github.com/sveltejs/kit/tree/master/packages/adapter-static) |
| 38 | +- [@sveltejs/adapter-netlify](https://github.com/sveltejs/kit/tree/master/packages/adapter-netlify) |
| 39 | +- ...more soon |
0 commit comments