some readme text to help get started

2023-09-13 19:08:49 -07:00
parent 795f547ff2
commit a60a022365
1 changed files with 10 additions and 0 deletions
@@ -0,0 +1,10 @@
+# simple url shortener
+
+this project is a simple solution to build out a URL shortener using
+Roda, Falcon, Sequel, and SQLite
+
+the point of this project is to quickly build something and work on continuous deployment while making small refinements to the functional pieces.
+
+before running the server, you must build the database by running the following:
+
+`sequel -m db/migrations sqlite://db/url_shortener.db`