Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Welcome to the Roxy wiki!
Roxy consists of three components:
- MVC Framework - Scaffolding to make writing code easier.
- Unit Testing Framework
- Deployer - allows you to easily scaffold and deploy your application. So easy that you can have an application up and running in 5 minutes or less.
The Roxy framework relies on convention over configuration. It consists of deploy and unit test components, as well as an approach for building applications. The build component uses a configuration file that specifies application server and database settings, with a reasonable set of defaults provided as a template. It provides a tool to easily build the configuration, deploy source code and load data to multiple environments. The default files provide targets for local, dev and prod environments.
The application development portion of the framework provides a Model-View-Controller setup, allowing for well structured applications. The Controllers convert user inputs to values that can be passed to library module functions. The Models encapsulate functionality that relates to some concept in the application (for example, you might have a model library module that contains the functions related to managing users in your application). The Views handle the presentation logic. This separation isolates the business logic, simplifying the writing of unit tests. Isolating presentation layer functionality means that the same endpoint can serve up HTML, XML, or JSON.
If you are on a *Nix system then you can download the Roxy Script and put it in your executable path. Note that it should be named "ml" (no extension) and that you need to make it executable (
chmod +x ml) .
To download the script with curl, you can use this command:
curl -o ml https://raw.githubusercontent.com/marklogic/roxy/master/ml
You can also create an alias to run the script from github directly. This won't work if you are without an internet connection.
> alias ml='bash <(curl -s https://raw.github.com/marklogic/roxy/dev/ml)'
With the script placed in your executable path, you can now run the ml command from anywhere on your system.
See the Quickstart to get started with Roxy. You should be able to have an application up and running in minutes.
See Roxy URL Rewriting for information on how Roxy routes URLs. This page also contains information on overriding the Roxy Rewriter.
Configuring Roxy Options
See Overriding Roxy Options for information on how to customize Roxy.
See the Security page for information about roles, users, amps, privileges, and SSL.
Having trouble? Try the Troubleshooting page.