Giter VIP home page Giter VIP logo

developers.fliit.de's Introduction

developers.fliit.de

This is Fliit's public API docs website, hosted at developers.fliit.de.

Project Structure

Run the docs locally with ReDoc

Run any local server one-liner on the root of this repo, such as:

$ ruby -run -e httpd . -p 9090
OR
$ python -m http.server 9090
OR
$ npm install -g node-static   # install dependency
$ static -p 9090
OR
$ php -S 127.0.0.1:9090
OR
https://gist.github.com/willurd/5720255

And open your browser at http://localhost:9090

Alternatively, run the docs locally with Swagger UI

$ docker pull swaggerapi/swagger-ui
$ docker run -p 9091:8080 -e SWAGGER_JSON=/bar/swagger.yml -v /path-to-this-repo:/bar swaggerapi/swagger-ui

Open http://0.0.0.0:9091 on your browser.

ReDoc dependency

Right now we are downloading the release file directly from Github and storing on version control directly instead of using a package manager.

Follow ReDoc releases for updates

Deploy

Make sure the $FLIIT_DEV_WEBSITE_BUCKET and $FLIIT_DEV_SITE_CLOUDFRONT_DIST_ID are set and run.

$ make deploy

The values that should be assigned to these env vars are available on the terraform output of devops repository. You can get them by running:

devops/terraform/base$ terraform output fliit_dev_website_export_env_var

And then execute the output as a command on your terminal.

Other important links:

© 2017 Fliit. Licensed under terms of Apache License v2

developers.fliit.de's People

Contributors

brunograsselli avatar lfcipriani avatar lucapette avatar

Stargazers

 avatar

Watchers

 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.