move solution notes to a separate file.

1 files changed, 35 insertions, 0 deletions

diff --git a/SOLUTION.md b/SOLUTION.md
new file mode 100644
index 0000000..0488b00
--- /dev/null
+++ b/SOLUTION.md
@@ -0,0 +1,35 @@
+### Solution
+
+This solution is hosted on heroku at: [http://infinite-atoll-2481.herokuapp.com](http://infinite-atoll-2481.herokuapp.com)
+
+#### Endpoints
+
+There are 3 different endpoints that serve these requirements. An
+example of how to connect to the endpoints can be found in [bin/acceptance.sh](bin/acceptance.sh)
+
+* GET /licenses - list of all well licenses
+* GET /licenses/:guid - details of a single license
+* GET /companies/:guid/licenses - list of all active licences for company
+* GET /companies/:guid/licenses?township=:township - list of active licenses for township, for company.
+* GET /companies/:guid/licenses?status=expired&township=:township - list of expired licenses for township, for company.
+
+##### Assumptions
+
+* Name of applicant is the name of the employee at the company that submitted the application.
+* Date of license is the date the license was issued.
+* Assume perf isn't the focus, so no need to over-engineer with a denorm read model.
+
+##### TODO
+
+* move secret token to env variable.
+* cache additional payload data.
+* resolve n+1 issues
+* figure out why location doesn't lazy load in jbuilder template.
+* rename license to well license
+
+##### nice to haves
+
+* simplecov
+* factory girl
+* dotenv
+* bullet