This is a demo repository for Fulcro RAD. It includes a shared source directory of files that would be common to any project, and then separate source directories that have specific files that would be needed to work with specific back-end technologies (currently SQL and Datomic).
|
Important
|
Login is [email protected] with password letmein.
|
|
Note
|
Pathom 3 is supported. See the pathom3 branch for a version
that uses that version instead. That branch will be merged as soon
as P3 is considered production-ready.
|
RAD is a set of libraries for Fulcro that have you model your data via attributes. An attribute is a description of a fact in your data model, that itself can have descritive data (ala RDF). Fulcro components can also be given data attributes. The combination of annotating components and the data model leads to some great synergies, since Fulcro itself already has the UI components participate in your application’s global data model.
The result is a system where a group of attributes can be leveraged to automatically create:
-
Database schema
-
Networking APIs
-
Documentation
-
UIs that pull exactly what they need
-
Applications that auto-normalize their client-side data
-
Form and Report generation
-
Federated data modes, where a cluster of attributes can actually live in disparate locations under different control.
and much more.
RAD includes a number of features that I would recommend in any new production project using Fulcro. This demo is a good reference for how to set up such a project; however, RAD is changing rapidly, so beware that this demo may be somewhat out of date. This is not a template project per-se, but the RAD approach of designing your data model via attributes that can then be leveraged to generate a lot of your boilerplate code is quite useful and powerful in all stages of development.
The demo should be relatively easy for even a beginner to understand and tinker with, and I hope it serves to inspire you to learn more about Fulcro in general; however, if you do not understand Fulcro, then you will very quickly run into difficulties.
Beginners should therefore start by learning core Fulcro via examples from the Developer’s Guide or even the standard https://github.com/fulcrologic/fulcro-template. RAD does not eliminate the need to understand the core library. RAD is simply some macros and patterns that leverage Fulcro.
The SQL version has some known bugs. If you want to play with RAD, use the Datomic database adapter for now.
- Does RAD Require a Database (or Server)?
-
No the general front-end elements of RAD could be powered by any data source. The main requirement is that a Fulcro "remote" exist which is able to support an EQL interface. It is trivial to build a remote that uses anything from an SQL database on a server to Browser LocalStorage.
You must compile the CLJS source to run the client. If you want to be able to edit it, just start a shadow-cljs watch:
$ yarn
$ shadow-cljs watch mainif you don’t have yarn, use npm install instead.
The Datomic database used in the demo is Datomic Cloud. On-prem is also supported (using a different namespace. See
the on-prem tag which uses older versions the datomic RAD plugin and Datomic free), but
the datomic-free version does not have enough features to support RAD. Datomic Cloud has a dev-local driver that can
be used to create in-memory database, which makes writing an easy-to-run demo more simple.
You will need to obtain the current version of dev-local from Cognitect in order to
run this demo (and update the deps.edn to reflect the version you got).
Once you have the dependencies you should be able to start the webapp in Datomic mode using:
$ clj -A:dev:datomic
user=> (clojure.core/require 'development)
user=> (development/go)This will seed the database and start the web server. The development namespace includes helpers for stopping/starting
and restarting (with code reload) the server-side code.
The example code should work with most SQL databases (and defaults to using an in-memory H2 db). The data source
is configured in the defaults.edn config file in the sql source
directory. See the HikariCP connection pool documentation.
The SQL example has a custom development namespace in the src/sql source
folder, along with components needed to run that server.
You can start the server-side version for SQL using the deps aliases that set up the proper classpath:
$ clj -A:dev:sql
user=> (clojure.core/require 'development)
user=> (development/go)The example code for XTDB components is in the src/xtdb folder, along with a custom
development.clj. XTDB nodes are configured by a map under :roterski.fulcro.rad.database-adapters.xtdb/databases key
in defaults.edn.
You can run it with the :xtdb deps alias:
$ clj -A:dev:xtdb
user=> (clojure.core/require 'development)
user=> (development/go)The example code for Asami components is in the src/asami folder, along with a custom
development.clj. Asami is configured by a map under ::cz.holyjak.rad.database-adapters.asami/databases key
in defaults.edn.
You can run it with the :asami deps alias:
$ clj -A:dev:asami
user=> (clojure.core/require 'development)
user=> (development/go)RAD uses several different libraries at once. It is ideal that you check out the source of all of those and set
up your deps so you can run from the source of them all at once. You may also want to update the set-refresh-dirs
in the development namespace to point at those additional source directories in CLJ so you get proper reload there.
The very active development I’m doing makes changes to 5 projects at once (Fulcro, Fulcro RAD, Fulcro RAD Datomic,
Fulcro RAD SQL, and this demo). I do not guarantee I will keep everything in sync as far as versions in the deps
file go. I personally set the following in my top-level ~/.clojure/deps.edn:
{:aliases {:f3-dev {:override-deps {com.fulcrologic/fulcro {:local/root "/Users/tonykay/fulcrologic/fulcro"
:exclusions [com.taoensso/sente]}}}
:rad-dev {:override-deps {com.fulcrologic/fulcro-rad {:local/root "/Users/username/fulcrologic/fulcro-rad"}
com.fulcrologic/fulcro-rad-sql {:local/root "/Users/username/fulcrologic/fulcro-rad-sql"}
com.fulcrologic/fulcro-rad-semantic-ui {:local/root "/Users/username/fulcrologic/fulcro-rad-semantic-ui"}
com.fulcrologic/fulcro-rad-datomic {:local/root "/Users/username/fulcrologic/fulcro-rad-datomic"
:exclusions [com.datomic/datomic-free]}}}}}so that in IntelliJ (or at the command line) I can work from local sources for all of them. I try to remember to push SNAPSHOTS daily, but if I forget and you see some missing symbol error or things are broken, that is almost certainly why.
Running shadow and clj would look like this from the command line:
# in one terminal
$ shadow-cljs -A:f3-dev:rad-dev watch main
# in another terminal
$ clj -A:dev:f3-dev:rad-dev:datomicIn IntelliJ, you’d simply make sure to run a CLJ REPL with current classpath, and use the alias checkboxes and + button
in the Clojure Deps tab to set it up.
The MIT License (MIT) Copyright (c), Fulcrologic, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.