https://github.com/federicoceratto/nim-package-directory

Nim package directory - documentation builder
https://github.com/federicoceratto/nim-package-directory

badges documentation-site nim nim-lang nim-language packaging rss-feed

Last synced: 6 days ago
JSON representation

Nim package directory - documentation builder

• Host: GitHub
• URL: https://github.com/federicoceratto/nim-package-directory
• Owner: FedericoCeratto
• License: gpl-3.0
• Created: 2016-08-20T19:59:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T22:46:16.000Z (over 1 year ago)
• Last Synced: 2023-03-22T12:49:33.260Z (over 1 year ago)
• Topics: badges, documentation-site, nim, nim-lang, nim-language, packaging, rss-feed
• Language: Nim
• Homepage: https://nimble.directory/
• Size: 3.04 MB
• Stars: 47
• Watchers: 7
• Forks: 15
• Open Issues: 16
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        

=== Nim package directory

Currently running at https://nimble.directory

.Features:

- [x] Package search

- [x] Display GitHub readme

- [ ] Display GitLab readme

- [ ] Display BitBucket readme

- [x] Fetch & install packages, serve badges

- [x] Build and serve pkg docs

- [x] New packages RSS feed

- [x] Search symbols from jsondoc

- [x] Simple API

- [x] Build history at /build_history.html

- [x] 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