From b0bf1a7cf41c1dd3758e4bf48c5bf5981beef35e Mon Sep 17 00:00:00 2001 From: Aaron Mueller Date: Sun, 19 Jan 2014 20:36:56 +0100 Subject: [PATCH] Some more documentation --- README.mkd | 26 +++++++++++++++++++------- dev/user.clj | 3 --- project.clj | 15 ++++++--------- src/ldview/core.clj | 7 +++++++ src/ldview/repl.clj | 1 + 5 files changed, 33 insertions(+), 19 deletions(-) delete mode 100644 dev/user.clj create mode 100644 src/ldview/core.clj diff --git a/README.mkd b/README.mkd index 221b341..2815732 100644 --- a/README.mkd +++ b/README.mkd @@ -5,15 +5,27 @@ dependencies. This takes a couple of seconds. After that, you can run the server with `lein ring server-headless`. Now you can verify that nothing went wrong if you open up the browser and visit http://0.0.0.0:3000/. There should be nothing displayed because we doesn't fetch any data yet. If that works, we can proceed -with the next step and import data. +with the next step and import data. You can leave the terminal open or start the +server just from the repl (preferred way). -Run a repl with `lein repl` in another terminal. Here we start the -server, initiate the database and run the scrape process. +Run a repl with `lein repl` in another terminal. Here we can start the +server, initiate the database and run the scrape process. First we start the server +(if not allready done) - (load-file "src/ldview/repl.clj") + (use 'ldview.repl) (ldview.repl/start-server) - (load-file "src/ldview/tasks/runner.clj) - (in-ns 'ldview.tasks.runner) - (load-competition 27 "10 Seconds") +Next, we set up the database and start the fetching process. This take a little +time, so make yourself a cup of tea and be proud of yourself to get this far :) + (use 'ldview.tasks.runner) + (ldview.tasks.runner/load-competition 27 "10 Seconds") + + +# Development + +Sure, you want to make some changes on the code. It's clojure, it will be fun. +The server is allready online and serving html pages. If you making changes on +the code, the browser automatically reload the page after every code change. If +you want to reload the code in the repl after making some changes, use +`:reload-all` in addition to the `use` function. diff --git a/dev/user.clj b/dev/user.clj deleted file mode 100644 index cb43b0b..0000000 --- a/dev/user.clj +++ /dev/null @@ -1,3 +0,0 @@ -(ns user) - -;; Place some code for the repl here diff --git a/project.clj b/project.clj index e6f12ec..ab4c547 100644 --- a/project.clj +++ b/project.clj @@ -18,20 +18,17 @@ [enlive "1.1.5"] [me.raynes/fs "1.4.5"]] - :source-paths ["dev"] + :main ldview.core :plugins [[lein-ring "0.8.10"]] :ring {:handler ldview.handler/app :init ldview.handler/init :destroy ldview.handler/destroy - :open-browser? false - :auto-reload? true - :auto-refresh? true} + :open-browser? false} :profiles { - :production {:ring {:open-browser? false - :stacktraces? false - :auto-reload? false - :auto-refresh? false}} - :dev {:dependencies [[ring-mock "0.1.5"] + :production {:ring {:stacktraces? false}} + :dev {:ring {:auto-reload? true + :auto-refresh? true} + :dependencies [[ring-mock "0.1.5"] [ring/ring-devel "1.2.0"]]}} :url "http://ldview.arg-games.com/" diff --git a/src/ldview/core.clj b/src/ldview/core.clj new file mode 100644 index 0000000..b252078 --- /dev/null +++ b/src/ldview/core.clj @@ -0,0 +1,7 @@ +(ns ldview.core + (:require [ldview.tasks.runner :as runner]) + (:gen-class)) + +;; TODO: Grab the title from the page +(defn -main [competition-id] + (runner/load-competition competition-id "some title")) diff --git a/src/ldview/repl.clj b/src/ldview/repl.clj index 9fedf6c..cbdb91d 100644 --- a/src/ldview/repl.clj +++ b/src/ldview/repl.clj @@ -26,6 +26,7 @@ :init init :destroy destroy :auto-reload? true + :auto-refresh? true :open-browser? false :join? false}))))