FedericoCeratto / 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: Netdata or StatsD to receive application metrics

Deployment:

sudo apt-get install nim dpkg-dev debhelper libsystemd-dev
nimble builddeb
# Locate and install the package
sudo apt install ../nim-package-directory_0.1.5_amd64.deb
sudo systemctl status nim-package-directory.service
sudo journalctl -f --identifier=package_directory

Development:

• For Development, edit /etc/nim-package-directory.conf

• Execute nim c -r package_directory.nim.

• Browse http://localhost:5000