Commit 732055b4 authored by Christophe Benz's avatar Christophe Benz
Browse files

Update README

parent 9ea6af3d
......@@ -24,7 +24,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 +34,33 @@ 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.
### Development
Other files under `src/` can be modified too, but require more development skills.
## 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
......
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