black-hammer-lib

bh-lib

The Black Hammer Library (bh-lib) is a fully standalone UI component library, written in Clojurescript. It makes it easy to use in your own projects, giving you variety of all different kinds of components.

Additionally, the repo provides a standalone Demonstration of all the UI components available. This provides 2 benefits:

1. If you want to use Bh-Lib in your own projects, you can use the Demo to see all the components avaialble
2. You can use the Demo as a hosting application for developing completely new components.

Atomic Design

Introduce Atomic Design and point to the page in the Demo/Catalog for further information

For Developers

Downloading the Code

To view the existing components or to develop new ones, simply clone the repo

git clone --recursive https://github.com/Sagura091/bh-lib.git

and load the project in the Clojure IDE of your choice.

Using the Demo

The Demo uses shadow-cljs as it's build and execution tool. Using a Terminal window, run:

./run-with-webpack.sh

This will download all the dependencies, compile the demo code, and start the demo running. Next, open your browser and navigate to:

http://localhost:8888

In a few seconds, you should see the Welcome Page.

Have fun exploring the various pages and examples!

Developing bh-lib

If you want to add new components to the library, follow the steps for getting the repo as shown above, start the Demo, and open your IDE.

Bh-lib uses the typical Clojurescript/Shadow-cljs workflow, with hot-reloading and repl-driven development

Using bh-lib in your own projects

It is easy to include bh-lib in your project, either with the Clojure CLI using deps.edn or Leiningen using project.clj. The deps.edn approach can work with both numbered releases or git-sha commits, but project.clj is limited to using only number releases.

Updating your deps.edn

Visit https://github.com/Sagura091/bh-lib and checkout the latest tags. If one of these meets your needs, then add the following to your deps.edn file:

{:deps [bh-lib/bh-lib {:git     "https://github.com/Sagura091/bh-lib"
                       :git/tag [the-tag-from-guthub-as-a-string]

If you prefer to use the most recent commit (or any other commit, really), add:

{:deps [bh-lib/bh-lib {:git     "https://github.com/Sagura091/bh-lib"
                       :git/sha [the-sha-from-guthub-as-a-string]

NOTE: you can find the most recent commit at the terminal using git rev-parse HEAD

Refresh you IDE if needed to enable the change, and restart any external builds you use when developing to be sure your executable environment is including the new dependency.

Updating your project.clj

Is this really possible?

Visit https://github.com/Sagura091/bh-lib and checkout the latest tags. If one of these meets your needs, then add the following to your project.clj file:

Example using a bh-lib UI component

Put some small example of the code needed to add a button form the library.

Additional Tooling

Splint

We're trying splint as a post-processing linter for possible use in a CI/CD chain.

From the project's root directory run:

clojure -M:splint [path]

For example, to lint just the UI component library, run:

clojure -M:splint src/bh_ui

To lint everything, library and demo:

clojure -M:splint .