fulcro-developer-guide

fulcro-developer-guide copied to clipboard

== Fulcro Developer's Guide

This is the source for the Developer's Guide of Fulcro version 3.

The source for v2 of the book is in the root of the Fulcro repository, at any 2.x tag.

== Generating HTML

make book
# or using docker:
make docker-html

== Generating a PDF

make pdf
# or using docker:
make docker-pdf

=== Prerequisites

asciidoctor-pdf is a ruby gem. It is recommended to manage userspace gems using rvm.

Please see the asciidoctor guide for more information

https://asciidoctor.org/docs/install-asciidoctor-macos/#rvm-procedure-recommended

=== Developing

• Generate html

$ make docker-html
or
$ make book

• Publish

$ rm -rf docs/js/book docs/js/book.js
$ npx yarn
$ shadow-cljs release book

• Run the server

npx shadow-cljs server

• Check the page at http://localhost:9005