Giter Club home page Giter Club logo

tutum-api-docs's Introduction

tutum/api-docs

Deploy to Tutum

Tutum API documentation available at https://docs.tutum.co/v2/api

If you find a typo or mismatch between the API and this documentation, please send us a pull request!

Usage

To run it locally:

git clone https://github.com/tutumcloud/api-docs.git
git submodule init && git submodule update 
docker build -t tutum/api-docs .
docker run -p 4567:4567 tutum/api-docs

The documentation will be available in http://localhost:4567/

Publishing

(Only authorized users)

To publish, run the following:

docker run -i -t -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY tutum/api-docs publish.sh

With appropiate credentials in $AWS_ACCESS_KEY_ID and $AWS_SECRET_ACCESS_KEY.

tutum-api-docs's People

Contributors

fermayo avatar tifayuki avatar maximeheckel avatar siedrix avatar bernardopericacho avatar

Watchers

mixxmac avatar James Cloos avatar  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.