Clojurians Log App

Clojure web app that serves up Slack chat history. This app was created to replace the old scripts that generated the site at clojurians-log.clojureverse.org. This app isn't live yet, but you can see it in action at clojurians-log-staging.clojureverse.org.

Besides serving its utilitarian function of serving logs, this also serves as an example open-source Clojure web app. It's small enough to easily understand and contribute to, while at the same time having a real-world use. This makes it a perfect match for people who want to get started with Clojure open source development. Together we can learn from each other, and make this an example of good Clojure practices.

Contributing

All kinds of contributions are welcome, code, documentation, tests, bug reports, ... We especially welcome first time contributors!

There are still many small things that need doing, have a look at the issues if you're curious to get started.

This project mostly follows the Clojure Community Style Guide, but also has some guidelines of its own.

Running the app

To run the app on your own laptop, you should first grab the demo data, so you have some Slack history to look at.

git clone https://github.com/clojureverse/clojurians-log-demo-data.git

Now you can start a REPL, import the data, and start the app:

lein repl
user=> (go)
...
Started clojurians-log on http://localhost:4983
:started
user=> (use 'clojurians-log.repl)
user=> (load-demo-data! "/path/to/clojurians-log-demo-data")
/path/to/clojurians-log-demo-data/2018-02-01.txt
/path/to/clojurians-log-demo-data/2018-02-02.txt
/path/to/clojurians-log-demo-data/2018-02-03.txt
...

You can see it in action at http://localhost:4983

Some tips on development

The code is roughly split in three parts: queries, views, and routes (you can think of it as MVC if you like). So the main namespaces to look at are

clojurians-log.views
clojurians-log.routes
clojurians-log.db.queries

These are all under src/clj.

In user.clj you'll find some useful helpers for use during development, so have a look at what's there!

user> (db)                               ;; Datomic db
user> (conn)                             ;; Datomic connection
user> (add-dependency [foo/bar "1.2.3"]) ;; Add a dependency without having to restart
user> (reset)                            ;; Reload modified namespaces and restart the app
user> (reset-all)                        ;; Reload all namespaces and restart the app
user> (last-request)                     ;; See the last ring request handled
user> (last-response)                    ;; See the last response the app generated

License

Distributed under the Mozilla Public License version 2.0.

Chestnut

Created with Chestnut 0.15.3-SNAPSHOT (6ef3c4bc).

petrusbr / clojurians-log-app Goto Github PK