diff --git a/price-service/README.md b/price-service/README.md index 2f61f2ab..07eb3447 100644 --- a/price-service/README.md +++ b/price-service/README.md @@ -1,78 +1,17 @@ # price-service/price-service -FIXME: my new application. +A replacement for a few modules from TraderX - using XTDB as storage to demonstrate [the power of bi-temporality](https://docs.xtdb.com/tutorials/financial-usecase/time-in-finance.html) -## Installation +## Under covers -Download from https://github.com/price-service/price-service +The price-service uses the [CSV with securities](resources/s-and-p-500-companies.csv) to prime a lookup table for stocks. It also assigns initial (pseudo-randomly generated) 'stock prices'. -## Usage +The tables are `stocks` and `stock_prices` respectively, stored in XTDB (which is run as part of [docker compose](../docker-compose.yml#25)) -FIXME: explanation +### Dev environment -Run the project directly, via `:exec-fn`: +Dockerfile is very simple - suitable for development. - $ clojure -X:run-x - Hello, Clojure! +### Production environment -Run the project, overriding the name to be greeted: - - $ clojure -X:run-x :name '"Someone"' - Hello, Someone! - -Run the project directly, via `:main-opts` (`-m price-service.price-service`): - - $ clojure -M:run-m - Hello, World! - -Run the project, overriding the name to be greeted: - - $ clojure -M:run-m Via-Main - Hello, Via-Main! - -Run the project's tests (they'll fail until you edit them): - - $ clojure -T:build test - -Run the project's CI pipeline and build an uberjar (this will fail until you edit the tests to pass): - - $ clojure -T:build ci - -This will produce an updated `pom.xml` file with synchronized dependencies inside the `META-INF` -directory inside `target/classes` and the uberjar in `target`. You can update the version (and SCM tag) -information in generated `pom.xml` by updating `build.clj`. - -If you don't want the `pom.xml` file in your project, you can remove it. The `ci` task will -still generate a minimal `pom.xml` as part of the `uber` task, unless you remove `version` -from `build.clj`. - -Run that uberjar: - - $ java -jar target/net.clojars.price-service/price-service-0.1.0-SNAPSHOT.jar - -## Options - -FIXME: listing of options this app accepts. - -## Examples - -... - -### Bugs - -... - -### Any Other Sections -### That You Think -### Might be Useful - -## License - -Copyright © 2024 Mpi - -_EPLv1.0 is just the default for projects generated by `deps-new`: you are not_ -_required to open source this project, nor are you required to use EPLv1.0!_ -_Feel free to remove or change the `LICENSE` file and remove or update this_ -_section of the `README.md` file!_ - -Distributed under the Eclipse Public License version 1.0. +If deploying in a more production-like setting - use [Dockerfile.production](Dockerfile.production)