Git Product home page Git Product logo

o2r-web-api's Introduction

o2r Web API

Project description: http://o2r.info

Basics

We're a research project, so everything in this API and its documentation is subject to change. We try to use "WORK IN PROGRESS" or "TBD" in headlines to signal things that are not working fully yet.

The "working" state should eventually always be in the master branch, which is published online at http://o2r.info/o2r-web-api, and open pull requests reflect things that are under development.

Build

This specification is written in Markdown and deployed automatically using Travis CI. You can use mkdocs to render it locally, or view the latest master-branch on http://o2r.info/o2r-web-api/. See the MkDocs documentation for details.

# pip install mkdocs
# mkdocs --version
mkdocs serve

mkdocs build

Automated Builds

Build Status

The current master branch is automatically built on Travis CI and deployed to the GitHub Page at http://o2r.info/o2r-web-api/. Our combination of the .travis.yml and .deploy.sh will run the mkdocs command on every direct commit or merge on the master branch and deploy the rendered HTML documents to the gh-pages branch in this repository.

Travis authenticates its push to the gh-pages branch using a personal access token of the user @o2r-user. The access token is encrypted in the .travis.yml using Travis CLI for the repository o2r-project/o2r-web-api:

travis encrypt GH_TOKEN=<token here>

The variable GH_TOKEN is used in the deploy script. The token generated on the GitHub website should not be stored anywhere, simply generate a new one if needed.

This has some security risks, as described here. To mitigate these risks, we have disabled the option "Build pull requests" is on the Travis configuration page for this repo, so that malicious changes to the Travis configuration file will be noticed by the repository maintainer before merging a pull request.

License

The o2r Web API specification is licensed under Creative Commons CC0 1.0 Universal License, see file LICENSE. To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work. This work is published from: Germany.

o2r-web-api's People

Contributors

jankoppe avatar jansule avatar lukaslohoff avatar nuest avatar tekraft avatar timmimim avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.