https://github.com/soveran/ox
Skeleton for a Cuba-based JSON API.
https://github.com/soveran/ox
Last synced: 7 months ago
JSON representation
Skeleton for a Cuba-based JSON API.
- Host: GitHub
- URL: https://github.com/soveran/ox
- Owner: soveran
- Created: 2013-07-03T17:55:48.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-04-07T08:37:37.000Z (over 10 years ago)
- Last Synced: 2024-02-17T13:32:13.216Z (over 1 year ago)
- Language: Ruby
- Size: 177 KB
- Stars: 16
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ox
Skeleton for self-contained, Cuba-based JSON API.
## Description
[Cuba](http://cuba.is) is a microframework for web development, and
this template provides a starting point for building an application
with a JSON API.
The sample application uses [Redis](http://redis.io) as the main
database, and the documentation will guide you on how to use the
`Ox` helper to interact with your application in a very simple way,
both for development and testing.
## Getting started
Make sure Redis is installed.
# Clone this repository:
$ git clone git@github.com:soveran/ox.git
# Go to the app's directory:
$ cd ox
# Read the documentation
$ make help
All the commands are run with `make`, and the guide provides a step
by step example of how to get started and how to interact with your
application.
## Removing the application
All the dependencies will be installed in your project directory,
so if you want to get rid of your project along with all its
dependencies, you can just remove that directory. There will be
absolutely no leftovers.
## Community
If you need help, please leave a note in the issues tracker or talk
to us on IRC, #lesscode at freenode.