summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjakefeasel <jfeasel@gmail.com>2012-10-12 22:31:54 -0700
committerjakefeasel <jfeasel@gmail.com>2012-10-12 22:31:54 -0700
commitfd258de8fe03d9a47777bd0a42258e85f8be41df (patch)
tree613517fd6a2c51b029d62599b766996155bcdc52
parent7402fb6b00ae783f6afbbb815fac88775de45e2e (diff)
downloadsqlfiddle-fd258de8fe03d9a47777bd0a42258e85f8be41df.zip
sqlfiddle-fd258de8fe03d9a47777bd0a42258e85f8be41df.tar.gz
sqlfiddle-fd258de8fe03d9a47777bd0a42258e85f8be41df.tar.bz2
Tweaks to default dev setup and instructions
-rw-r--r--README.md24
-rw-r--r--src/main/webapp/config/design/.gitignore1
-rw-r--r--src/main/webapp/config/design/settings.cfm (renamed from src/main/webapp/config/design/settings.cfm.example)2
3 files changed, 17 insertions, 10 deletions
diff --git a/README.md b/README.md
index abe6892..102db97 100644
--- a/README.md
+++ b/README.md
@@ -7,23 +7,31 @@ See [the SQL Fiddle about page](http://sqlfiddle.com/about.html) page for backgr
## Getting the project up and running
-Fork the code on github to a local branch for youself. *git clone* and then from within your working copy, run this:
+Fork the code on github to a local branch for youself.
+
+From within your local working copy, **copy the file src/main/webapp/config/environment.cfm.example to src/main/webapp/config/environment.cfm**
+
+If you haven't already got [Maven](http://maven.apache.org), install it now.
+
+From the root of your working copy, run this:
mvn jetty:run
-Once everything downloads and runs, the app will be running on [localhost:8080](http://localhost:8080). The document root being served is src/main/webapp.
+Once everything downloads and runs, the app will be running on [localhost:8080](http://localhost:8080). Watch for this message in your console:
-You'll want to set the Railo Admin password right away. Here's the link to get there, once you have Jetty running:
+ [INFO] Started Jetty Server
+
+You can access your local server after you see this.
-[Local Railo Admin](http://localhost:8080/railo-context/admin/web.cfm)
+You must set the Railo Admin password right away. Here's the link to get there, once you have Jetty running:
-Copy the file src/main/webapp/config/environment.cfm.example to src/main/webapp/onfig/environment.cfm
+[Local Railo Admin](http://localhost:8080/railo-context/admin/web.cfm)
-Copy the file src/main/webapp/config/design/settings.cfm.example to src/main/webapp/config/design/settings.cfm
+The simplest thing to do would be to set the password just to "password" (no quotes). This is the default password in the config. If you choose to use another Railo admin password, you must set it in the file src/main/webapp/config/design/settings.cfm and update the CFAdminPassword.
-Edit src/main/webapp/onfig/design/settings.cfm and update the CFAdminPassword value to be whatever you used for your Railo admin password.
+You should now have a functional copy of SQL Fiddle running locally. Out of the box, the only database "servers" you have are SQLite instances (since those actually run in your browser). Setting up others requires separate work for each one (and isn't really necessary for most development work).
-You should now have a functional copy of SQL Fiddle running locally. You won't have much in the way of database backends, of course, since setting those up requires separate work for each one (and isn't really necessary for most development work).
+The document root being served is src/main/webapp. You can edit the files under there and see the changes immediately upon refresh (no need to restart the jetty server).
I'm happy to entertain pull requests!
diff --git a/src/main/webapp/config/design/.gitignore b/src/main/webapp/config/design/.gitignore
deleted file mode 100644
index 9c53ff0..0000000
--- a/src/main/webapp/config/design/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-/settings.cfm
diff --git a/src/main/webapp/config/design/settings.cfm.example b/src/main/webapp/config/design/settings.cfm
index 581ac1c..82f4859 100644
--- a/src/main/webapp/config/design/settings.cfm.example
+++ b/src/main/webapp/config/design/settings.cfm
@@ -5,6 +5,6 @@
--->
- <cfset set(CFAdminPassword="admin")>
+ <cfset set(CFAdminPassword="password")>
<cfset set(showDebugInformation=false)>
\ No newline at end of file