Commit 5518562d authored by Emmanuel Raviart's avatar Emmanuel Raviart

Rename project and move it to another repository.

parent a03e0431
# sapper-template
# Discourse-Ambiancer
The default [Sapper](https://github.com/sveltejs/sapper) template. To clone it and get started:
_A web site to animate hackathons by displaying automatic slideshows using data retrieved with Discourse API_
```bash
npx degit sveltejs/sapper-template my-app
cd my-app
npm install # or yarn!
npm run dev
```
**CAUTION: This project has been renamed to _Ambiancer_. Its development continues on another repository: https://framagit.org/eraviart/ambiancer.**
Open up [localhost:3000](http://localhost:3000) and start clicking around.
**This repository is now deprecated, but development continues on [Ambiancer repository](https://framagit.org/eraviart/ambiancer).**
Consult [sapper.svelte.technology](https://sapper.svelte.technology) for help getting started.
Ambiancer can be used to:
* display a slide for each pitch, with a timer that rings when speaking time is exceeded
* display an automatic slideshow of service messages
## Structure
The pitches, presentations and services messages must be written using [Discourse](https://www.discourse.org/) topics. Ambiancer just allows an administrator to manage them.
Sapper expects to find three directories in the root of your project — `app`, `assets` and `routes`.
Ambiancer has been designed to work with [Vitrine](https://framagit.org/eraviart/vitrine), but it doesn't require it.
Usages examples:
### app
* [#dataFin hackathon](https://datafin.fr/)
The [app](app) directory contains the entry points for your app — `client.js`, `server.js` and (optionally) a `service-worker.js` — along with your main `App.html` component.
_Ambiancer_ is free and open source software.
### assets
The [assets](assets) directory contains any static assets that should be available. These are served using [serve-static](https://github.com/expressjs/serve-static).
In your [service-worker.js](app/service-worker.js) file, you can import these as `assets` from the generated manifest...
```js
import { assets } from './manifest/service-worker.js';
```
...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files).
### routes
This is the heart of your Sapper app. There are two kinds of routes — *pages*, and *server routes*.
**Pages** are Svelte components written in `.html` 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.)
**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.
There are three simple rules for naming the files that define your routes:
* A file called `routes/about.html` corresponds to the `/about` route. A file called `routes/blog/[slug].html` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route
* The file `routes/index.html` (or `routes/index.js`) corresponds to the root of your app. `routes/about/index.html` is treated the same as `routes/about.html`.
* 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 `routes/_helpers/datetime.js` and it would *not* create a `/_helpers/datetime` route
## Webpack config
Sapper uses webpack to provide code-splitting, dynamic imports and hot module reloading, as well as compiling your Svelte components. As long as you don't do anything daft, you can edit the configuration files to add whatever loaders and plugins you'd like.
## Production mode and deployment
To start a production version of your app, run `npm run build && npm start`. This will disable hot module replacement, and activate the appropriate webpack plugins.
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:
```bash
npm install -g now
now
```
## Using external components
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.
Because of that, it's essential that webpack doesn't treat the package as an *external dependency*. You can either modify the `externals` option in [webpack/server.config.js](webpack/server.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:
```bash
yarn add -D @sveltejs/svelte-virtual-list
```
## Bugs and feedback
Sapper is in early development, and may have the odd rough edge here and there. Please be vocal over on the [Sapper issue tracker](https://github.com/sveltejs/sapper/issues).
* [software repository](https://framagit.org/eraviart/ambiancer)
* [GNU Affero General Public License version 3 or greater](https://framagit.org/eraviart/ambiancer/blob/master/LICENSE.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment