An open API service indexing awesome lists of open source software.

https://github.com/eclipse-biscuit/website

website for Biscuit tokens
https://github.com/eclipse-biscuit/website

Last synced: 6 months ago
JSON representation

website for Biscuit tokens

Awesome Lists containing this project

README

          

# Biscuit website

The website is made up of two parts: the main website ()
and the documentation website (). Both sites
require a JS bundle for editor components to work correctly.

## Required tools

The website requires the following tools:

- `npm` for bundling frontend assets
- `zola` for building the main website
- `mdbook` for building the documentation website

`zola` and `mdbook` can be downloaded from the release pages:

-
-

`npm` can be installed through your operating system tooling or via `nvm`.

## Frontend build

- go to the `wc/` directory
- `npm install`
- `npm run build`

## Preview the main website output

- make sure you've built the frontend bundle
- run `zola serve`
- point your browser to the URL displayed in the console output

Running `zola build` and opening generated files directly in your browser won't
work as the datalog component files require being served over HTTP.

## Preview the documentation output

- make sure you've built the frontend bundle
- go to the `docs/` directory
- run `mdbook serve`
- point your browser to the URL displayed in the console output

Running `mdbook serve` and opening generated files directly in your browser won't
work as the datalog component files require being served over HTTP.