https://github.com/srid/zulip-archive

Zulip Archive viewer (statically generated HTML)
https://github.com/srid/zulip-archive

functional-programming static-site zulip

Last synced: 2 months ago
JSON representation

Zulip Archive viewer (statically generated HTML)

• Host: GitHub
• URL: https://github.com/srid/zulip-archive
• Owner: srid
• Created: 2020-01-26T23:35:10.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T20:03:04.000Z (8 months ago)
• Last Synced: 2024-10-11T23:49:38.279Z (3 months ago)
• Topics: functional-programming, static-site, zulip
• Language: Haskell
• Homepage: https://funprog.srid.ca
• Size: 8.78 MB
• Stars: 13
• Watchers: 5
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# zulip-archive

Zulip archive viewer written in Haskell, using the [rib](https://github.com/srid/rib) static site generator.

[Demo](https://funprog.srid.ca/)

## Prerequisites

First, install the [Nix package manager](https://nixos.org/nix/):

``` bash

bash <(curl https://nixos.org/nix/install)

```

Optionally, enable the [Nix cache](https://srid.cachix.org/) if you would like to speed up local builds:

``` bash

# If you do not already have cachix, install it:

nix-env -iA cachix -f https://cachix.org/api/v1/install

# Enable nix cache for rib

cachix use srid

```

### Zulip API Key

Get your API key for zulip ([instructions here](https://zulipchat.com/api/api-keys)). Note: you are looking for *your* API key, and not a bot's API key.

## Running

First, create a configuration file, adding your Zulip site settings (including the API key):

```

cp config/config.example.dhall config/config.dhall

vim config/config.dhall

```

NOTE: You can also pass the contents of the config file in the environment variable `ZULIP_ARCHIVE_CONFIG` which takes precedence over the config file. This can be used to setup GitHub Pages workflow (see `./.github/workflows`).

To build and run the site:

```bash

bin/run

```

Go to http://localhost:7004 to view your generated site.

## Manual update

User uploaded files are unavailable via the API. They must be manually exported (needs admin rights), and copied to `./site/user_uploads`.