Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.95 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.95 KB

docs.*

Repository to centralize Projects, Issues and things cross all docs.* repositories.

Repositories

  • docs.extractor - Tool to extract namespace/functions documentation from Clojure projects into indexed Datalevin file.
  • docs.backend - Backend Service for docs.clj.codes
  • docs.frontend - Frontend SPA for docs.clj.codes

Projects

Using the project

Configuration

Here some documentation about how to configure the repositories:

  • docs.extractor - Definitions of where to store the database and which libraries to analyze and index
  • docs.backend - Webserver, Database and Github api configurations
  • docs.frontend - Base backend url and github client for login

How to use

After configuring the repositories you can run the database extraction on docs.extractor, then copy the resulting files inside the docs.backend (you can configure the url auto download in the config) and start it together with the docs.frontend.

Today I use fly.io on docs.clj.codes to deploy this setup you can check the Github actions deploy files (backend, frontend) for some inspiration.

This setup is costing only $5/month currently: image