Skip to content
Browse files

first commit

  • Loading branch information...
0 parents commit 753a99d8f43f3c9de60047c6be7872870901bcd2 @dscape committed
Showing with 128 additions and 0 deletions.
  1. +5 −0 CHANGES.md
  2. +6 −0 CONTRIBUTORS.md
  3. +13 −0 LICENSE
  4. +93 −0 README.md
  5. +11 −0 package.xml
  6. 0 rewrite.xqy
5 CHANGES.md
@@ -0,0 +1,5 @@
+# rewrite changes
+
+## 0.1
+
+* Not yet
6 CONTRIBUTORS.md
@@ -0,0 +1,6 @@
+# Contributors
+
+* [Nuno][1] Job ( [@dscape][2] )
+
+[1]: http://github.com/dscape
+[2]: http://twitter.com/dscape
13 LICENSE
@@ -0,0 +1,13 @@
+Copyright 2011 Nuno Job
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
93 README.md
@@ -0,0 +1,93 @@
+# rewrite
+
+The purpose of the rewrite script is to eliminate the 1-to-1 mapping between files and MarkLogic
+App Servers by introducing a intermediate layer that recognizes URLs and dispatches them
+to application code.
+
+This project also tries to help you to make security part of this process by introducing
+XQuery constraints.
+
+rewrite is designed to work with [MarkLogic][2] Server only. However it can easily be ported
+to another product that understands XQuery and has similar capabilities.
+
+## Usage
+
+Not yet
+
+* Install
+* Point app Server to rewrite
+* Makes routes and supporting XQuery
+* Done
+
+Check features for a description of what the `routes.xml` file translates to.
+
+## Contribute
+
+Everyone is welcome to contribute.
+
+1. Fork rewrite in github
+2. Create a new branch - `git checkout -b my-branch`
+3. Test your changes
+4. Commit your changes
+5. Push to your branch - `git push origin my-branch`
+6. Create an pull request
+
+The documentation is severely lacking. Feel free to contribute to the wiki if
+you think something could be improved.
+
+### Running the tests
+
+To run the tests simply point an MarkLogic HTTP AppServer to the root of rewrite
+
+You can run the tests by accessing:
+(assuming 127.0.0.1 is the host and 8090 is the port)
+
+ http://127.0.0.1:8090/tests
+
+Make sure all the tests pass before sending in your pull request!
+
+### Report a bug
+
+If you want to contribute with a test case please file a [issue][1] and attach
+the following information:
+
+* Not yet
+
+This will help us be faster fixing the problem.
+
+An example for a Hello World test would be:
+
+ Not yet
+
+This is not the actual test that we run (you can see a list of those in test/index.xqy) but it's all the information we need for a bug report.
+
+## Supported Functionality
+
+Not yet
+
+### Roadmap
+
+If you are interested in any of these (or other) feature and don't want to wait just read the instructions
+on "Contribute" and send in your code
+
+* Not yet.
+
+### Known Limitations
+
+In this section we have the know limitations excluding the features that are not supported.
+To better understand what is supported refer to the Supported Features section
+
+* Not yet
+
+## Meta
+
+* Code: `git clone git://github.com/dscape/rewrite.git`
+* Home: <http://github.com/dscape/rewrite>
+* Discussion: <http://convore.com/marklogic>
+* Bugs: <http://github.com/dscape/rewrite/issues>
+
+(oO)--',- in [caos][3]
+
+[1]: http://github.com/dscape/rewrite/issues
+[2]: http://marklogic.com
+[3]: http://caos.di.uminho.pt
11 package.xml
@@ -0,0 +1,11 @@
+<package type="main">
+ <name>rewrite</name>
+ <author>Nuno Job [nunojobpinto@gmail.com]</author>
+ <description>Dispatch HTTP requests to controllers according to a DSL</description>
+ <repo type="git" tag="0.1">
+ git://github.com/dscape/rewrite.git
+ </repo>
+ <keywords>rewriter, dispatcher, routing, marklogic</keywords>
+ <version>0.1</version>
+ <main>rewrite.xqy</main>
+</package>
0 rewrite.xqy
No changes.

0 comments on commit 753a99d

Please sign in to comment.
Something went wrong with that request. Please try again.