zedeus/nim-package-directory

Nim package directory - documentation builder

Nim package directory

Currently running at https://nimble.directory

Features:

• ✓ Package search

• ✓ Display GitHub readme

• ❏ Display GitLab readme

• ❏ Display BitBucket readme

• ✓ Fetch & install packages, serve badges

• ✓ Build and serve pkg docs

• ✓ New packages RSS feed

• ✓ Search symbols from jsondoc

• ✓ Simple API

• ✓ Build history at /build_history.html

• ✓ Package count at /api/v1/package_count

• ❏ Pkg metadata signing

Prerequisites :

• systemd watchdog

• optional: StatsD to receive application metrics

Use:

• For Development, Copy and edit conf.json.example to conf.json.

• Download the Nims packages.json to projects root folder: https://raw.githubusercontent.com/nim-lang/packages/master/packages.json

• Execute nim c -r package_directory.nim.

• Open on the web browser http://localhost:5000/search