Glam is an app for linguistic data annotation that's still under construction. It's built using Clojure(Script), Material-UI, Fulcro, and XTDB. Check back soon 🚧
Resources:
(These instructions are a sketch--more detailed instructions will be given later.)
First, take care of dependencies. You will need to:
# install dependencies
$ yarn
# start compiling CLJS--leave this running in a terminal session...
$ yarn client
# and in a separate session, start a server repl--note you'll have to type `(start)`
$ yarn server
clojure -A:dev
Clojure 1.10.1
user=> (start)
# navigate to localhost:8085, and see package.json for more
On the terminal:
yarn client
Clojure Server Profile:
dev
in Aliasessrc/dev/user.clj
for development tools.ClojureScript Client Profile:
nREPL
glam
(start)
in the server. localhost:8085
(require '[shadow.cljs.devtools.api :as shadow])
(shadow/repl :main)
(js/console.log "hi")
and ensure that it was printed out to the console in your browser sessionNote: all docs
command will require additional dependencies for asciidoctor
. Use gem
to get them.
client
: Start the shadow-cljs ClojureScript compiler, which will compile code to JS and also hot reload any changes.client/cljs-repl
: Get a client CLJS REPL (note: requires a running browser session).client/clj-repl
: Get a client CLJ REPL (note: this is only useful if you want to fiddle with shadow-cljs, which is rare).server
: Start a server REPL. (This will not start the server automatically--to do that, you need to type (start)
.) start
: Convenience function for running client/main
and server
.clean
: Remove all compilation artefacts. client/release
: Build the single .js
bundle for a production release.server/release
: Build the single .jar
file for a production release.release
: Convenience function for running client/release
and server/release
.test
: Run all Clojure tests. (Currently, there are no CLJS tests.)clojure-outdated
: Check Clojure dependencies for oudatedness.npm-outdated
: Check NPM dependencies for outdatedness.loc
: Count lines of code (requires cloc
: npm install -g cloc
).docs/html
: Compile docs/book.adoc
into HTML at target/book.html
docs/pdf
: Compile docs/book.adoc
into a PDF at target/book.pdf
docs
: Perform docs/html
and docs/pdf
Navigate to http://localhost:8085/rest-api/v1/docs/index.html
Set the environment variable XTDB_INSPECTOR_URI_PREFIX=/_inspector
(e.g. XTDB_INSPECTOR_URI_PREFIX=/_inspector yarn server
), and see http://localhost:8085/_inspector/attr