Scheme index site

Table of Contents

• Building static site GUI
• Running in development
  • Natively
  • Docker compose

Static site frontend for https://github.com/schemeorg-community/scheme-index content.

Deployed at https://index.scheme.org.

Building static site GUI

Important

Make sure git submodule containing the data is checked out git submodule update --init

1. (option 1) Build natively

   1. Install:

      1. Chicken scheme compiler;

      2. json, matchable, srfi 1 chicken eggs;

      3. nodejs and npm.

   2. Execute bash build.sh in build directory

2. (option 2) Build with docker

   1. Install docker

   2. Execute in build directory:

      docker build -f ./Dockerfile .. -t scheme-index:latest
      docker create --name dummy scheme-index:latest
      docker cp dummy:/schemeindex.zip ./schemeindex.zip
      docker rm -f dummy

3. You’ll find schemeindex.zip after successful build, which you can deploy from any web server.

If you plan serving not from root, edit index.html file and change <base href="."> to point to appropriate prefix.

The site uses html5 routing. To enable entering the site from any route, you have to configure web server to serve index.html for paths that don’t match static resources. E.g., in nginx:

        location / {
            try_files $uri $uri/ /index.html =404;
        }

Running in development

Important

Make sure git submodule containing the data is checked out git submodule update --init

Natively

1. Install:

   1. Chicken scheme compiler;

   2. json, matchable, srfi 1 chicken eggs;

   3. nodejs and npm.

2. Build json data files from primary sexpr data (only need to do it once initially; or when you want to rebuild from latest upstream data):

   cd scheme-index-util
   csc buildtypes.scm
   csc buildfilters.scm
   cd ../data
   ../scheme-index-util/buildtypes types/index.scm ../scheme-index-app/src/assets/types.json
   ../scheme-index-util/buildfilters filters/index.scm ../scheme-index-app/src/assets/filters.json

3. From scheme-index-app:

   1. Execute npm i (Only need to do it once initially, and after package.json changes);

   2. Run npm run start

4. The site will be available at http://localhost:4200.

Docker compose

Run docker compose up from build directory, the site will be available at http://localhost:8080.