Commit 9ea6af3d authored by Emmanuel Raviart's avatar Emmanuel Raviart
Browse files

Re-add updated LICENSE.md & restore previous README.md.

parent 7bf1fd62
# Vitrine
_Web site displaying pages & data retrieved dynamically from other sites_
By:
* Xavier Arques <mailto:xavierarques@yahoo.com>
* Christophe Benz <mailto:christophe.benz@jailbreak.paris>
* François Bouchet <mailto:francoisbouchet@gmail.com>
* Emmanuel Raviart <mailto:emmanuel@raviart.com>
Copyright (C) 2018 Xavier Arques, François Bouchet, Paula Forteza & Emmanuel Raviart
Copyright (C) 2019 Christophe Benz & Emmanuel Raviart
https://framagit.org/eraviart/vitrine
> Vitrine is free software; you can redistribute it and/or modify
> it under the terms of the GNU Affero General Public License as
> published by the Free Software Foundation, either version 3 of the
> License, or (at your option) any later version.
>
> Vitrine is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU Affero General Public License for more details.
>
> You should have received a copy of the GNU Affero General Public License
> along with this program. If not, see <http://www.gnu.org/licenses/>.
# sapper-template
# Vitrine
The default [Sapper](https://github.com/sveltejs/sapper) template, available for Rollup and webpack.
_Web site displaying pages & data retrieved dynamically from other sites_
![Screenshot of a web site based on Vitrine](https://forum.parlement-ouvert.fr/uploads/default/optimized/1X/a0a1d5850054eadca16d05a019b5165e08ed9c87_1_623x500.jpg)
## Getting started
_Vitrine_ is an application that generates dynamically the landing pages of a web site using documents & data retrieved from other sites (using their APIs).
It can currently use pages from:
* [Discourse](https://www.discourse.org/) forums
* [GitLab](https://about.gitlab.com/) projects & groups
### Using `degit`
It can be used as the home page for a hackathon, to display the projects, the datasets, the participants, etc.
[`degit`](https://github.com/Rich-Harris/degit) is a scaffolding tool that lets you create a directory from a branch in a repository. Use either the `rollup` or `webpack` branch in `sapper-template`:
```bash
# for Rollup
npx degit "sveltejs/sapper-template#rollup" my-app
# for webpack
npx degit "sveltejs/sapper-template#webpack" my-app
```
_Vitrine_ started as a clone of [Hackdash](https://hackdash.org/), but instead of having its own back-office, it used Discourse and benefits from it power and versatility.
Usages examples:
### Using GitHub templates
* [AGDIC Hackathon 2019](https://agdic-hackathon.org/)
* [#dataFin Hackathon](https://datafin.fr/)
Alternatively, you can use GitHub's template feature with the [sapper-template-rollup](https://github.com/sveltejs/sapper-template-rollup) or [sapper-template-webpack](https://github.com/sveltejs/sapper-template-webpack) repositories.
_Vitrine_ is free and open source software.
* [software repository](https://framagit.org/eraviart/vitrine)
* [GNU Affero General Public License version 3 or greater](https://framagit.org/eraviart/vitrine/blob/master/LICENSE.md)
### Running the project
However you get the code, you can install dependencies and run the project in development mode with:
## Installation & Configuration
```bash
cd my-app
npm install # or yarn
npm run dev
git clone https://framagit.org/eraviart/vitrine.git
cd vitrine/
npm install
```
Open up [localhost:3000](http://localhost:3000) and start clicking around.
Consult [sapper.svelte.dev](https://sapper.svelte.dev) for help getting started.
## Structure
Sapper expects to find two directories in the root of your project — `src` and `static`.
### src
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.
#### src/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 `.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.)
**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 `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
* 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`.
* 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
## Customization
### static
The [static](static) directory contains any static assets that should be available. These are served using [sirv](https://github.com/lukeed/sirv).
In your [service-worker.js](src/service-worker.js) file, you can import these as `files` from the generated manifest...
```js
import { files } from '@sapper/service-worker';
To customize Vitrine, edit `site/index.js`. Then validate it and generate `site/site.json` by running:
```bash
node generate-site.js site/
```
...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files).
## Bundler config
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.
## Production mode and deployment
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.
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:
### Development
```bash
npm install -g now
now
npm run dev
```
## 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 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:
### Development
```bash
npm install -D @sveltejs/svelte-virtual-list
npm run build
```
## Discourse Configuration
## Bugs and feedback
Discourse must be configurated to accept requests coming from another site (ie CORS must be enabled to accept requests coming from Vitrine web site).
In file `/var/discourse/containers/app.yml`, add line:
```yaml
env:
[...]
DISCOURSE_ENABLE_CORS: true
```
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).
Then in Discourse admin web page `/admin/site_settings/category/security` fill field **cors origin** with the URL of the Vitrine web site.
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