Commit f42d6dcc authored by Emmanuel Raviart's avatar Emmanuel Raviart
Browse files

Merge branch 'update-readme-and-footer' into 'master'

Update readme and footer

See merge request eraviart/vitrine!2
parents 9ea6af3d e58d3ffa
......@@ -2,6 +2,8 @@
_Web site displaying pages & data retrieved dynamically from other sites_
[Demo](https://eraviart.frama.io/vitrine/)
![Screenshot of a web site based on Vitrine](https://forum.parlement-ouvert.fr/uploads/default/optimized/1X/a0a1d5850054eadca16d05a019b5165e08ed9c87_1_623x500.jpg)
_Vitrine_ is an application that generates dynamically the landing pages of a web site using documents & data retrieved from other sites (using their APIs).
......@@ -24,7 +26,7 @@ _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)
## Installation & Configuration
## Installation
```bash
git clone https://framagit.org/eraviart/vitrine.git
......@@ -34,26 +36,35 @@ npm install
## Customization
To customize Vitrine, edit `site/index.js`. Then validate it and generate `site/site.json` by running:
```bash
node generate-site.js site/
```
The easiest way to customize Vitrine is to fork this repository and edit `content/config.yml` and the other files in this directory.
Other files under `src/` can be modified too, but require more development skills.
If you enable GitLab pages in your fork, your fork will be deployed automatically under `https://<username>.frama.io/vitrine/`
### Development
## Development
```bash
npm run dev
```
### Development
If you change `content/config.yml` or any file in `src/`, the application will reload.
### Production
To build the application for a production use:
```bash
npm run build
npm run export
```
This will generate a `__sapper__/export/` directory containing the static website.
See also `.gitlab-ci.yml` for an example.
## Discourse Configuration
Discourse must be configurated to accept requests coming from another site (ie CORS must be enabled to accept requests coming from Vitrine web site).
Discourse must be configured 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
......
<footer class="bg-gray-100 text-center border-t border-grey p-4">
This website is based on
<a class="a" href="https://framagit.org/eraviart/vitrine" target="_blank">
Vitrine
</a>
– a Hackathon Dashboard powered by
<a class="a" href="https://www.discourse.org/" target="_blank">Discourse</a>
and
<a class="a" href="https://about.gitlab.com/" target="_blank">GitLab</a>
</footer>
......@@ -11,7 +11,8 @@
ProgressLinear
} from "smelte"
import { breakpoint } from "../stores.js"
import StickyFooter from "../components/StickyFooter.svelte"
import Footer from "../../content/Footer.svelte"
import StickyFooterLayout from "../components/StickyFooterLayout.svelte"
const { preloading, page, session } = stores()
......@@ -38,7 +39,7 @@
</title>
</svelte:head>
<StickyFooter>
<StickyFooterLayout>
<div slot="content">
{#if $preloading}
<ProgressLinear app />
......@@ -98,18 +99,7 @@
</main>
{/if}
</div>
<footer
slot="footer"
class="bg-gray-100 text-center border-t border-grey p-4">
<a
class="a"
href="https://framagit.org/jailbreak/vitrine/tree/svelte-3"
target="_blank">
Vitrine
</a>
– a Hackathon Dashboard powered by
<a class="a" href="https://www.discourse.org/" target="_blank">Discourse</a>
and
<a class="a" href="https://about.gitlab.com/" target="_blank">GitLab</a>
</footer>
</StickyFooter>
<div slot="footer">
<Footer />
</div>
</StickyFooterLayout>
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