# Skrimish

![logo](doc/logo.svg "Skrimish")

A stock exchange simulator.  The scope of this project is not yet defined but it should
allow end user(s?) to exchange securities via the common exchange rules.


## Getting Started

### Development

In development, you need nothing else than [clojure](https://clojure.org/)
and [leiningen](https://leiningen.org/).  The easiest way to install clojure is
to make sure you have java (8 and above) and install leiningen.

### Production

You will need plenty of things, the majority of them are yet to define.
But, a good kafka deployment will be required.  Probably a database,
hopefully datomic.


### Configuration
All configuration are set in the `resources/config.edn` file.
Configuration uses [aero](https://github.com/juxt/aero).  The configuration
file should be self documented.

### Technologies

#### Server
* [clojure](https://clojure.org/) for programming language
* [kafka](http://kafka.apache.org/) for message broker/database

#### In the browser
* [clojure script](https://clojurescript.org/) for programming language
* [sparks](https://aftertheflood.com/projects/sparks/) for trivial charts
* [metricsgraphicsjs](http://metricsgraphicsjs.org/) for complex charts



## License

Copyright © 2018 didier amyot

Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.