Zipshare API
The Zipshare API is a RESTful API for the ZipShare hosting and sharing service. The API allows integrations of ZipShare functionality into browsers, mobile apps, and command line tools. Features are built into the API before being added into the web or command line clients.
Getting started
Install all the dependencies, then run:
$ make setup # Install gems and setup the database.
$ make run # Runs the API locally
$ make test # Runs all the tests
$ make docs # Generates API and code documentation
Contributing
Our contribution guidelines are summarized as:
- Work on whatever is ready or anything you believe fits in the vision of ZipShare.
- Create issues when you think of an enhancement or find a bug. Submit patches when you can.
- CodeUnion owns all the code and related assets.
- Be compassionate and kind to one another. Harassment or verbal abuse of any kind is not tolerated.
Dependencies
- Ruby 2.2
- Bundler
- make
- Postgresql