nigeldaniels / firemore

Firebase + Clojure -> Firemore

Firemore

Firemore is a library for writing clojurescript applications using Google Firestore.

Please go to firemore.org for the interactive version of this documentation.

Main features include:

1. A direct API to the Firestore Database.
2. Automatic (and customizable) conversions between clojure maps and Firestore "json" documents.
3. A channels based API for getting and observing Firestore documents.
4. A binding between the Firestore Cloud database and a local clojure atom (great for om/re-frame/reagent).

Do It Live!

Please go to firemore.org for the interactive version of this documentation.

Getting Started

To use firemore in an existing project, add this to your dependencies in project.clj (lein) or build.boot (boot).

Additional Statuses

What?	Why?
	Do the test pass?
	Do the test pass right now?
	Did master deploy correctly?

Usage

Interactive Examples

firemore.org contains interactive code demonstrating most features; much thanks to Klipse for making this possible.

API

API for most recent version

Test

Run the test directly in your browser

Contributing

Pull Request are always welcome and appreciated. If you want to discuss firemore, I am available most readily:

1. On clojurians.slack.com under #firemore.
2. Through the issue tracking system.
3. By email at [email protected] .

Credits

Stephen Cagle is a Senior Software Engineer at Sam's Club in San Bruno, CA. He is the original (currently only, but always accepting PRs!) creator/maintainer of firemore. @github @linkedin

License

MIT License

Copyright (c) 2021 Stephen Cagle