Giter VIP home page Giter VIP logo

lara-interactive-api's Introduction

LARA Interactive API Sandbox

This is the repository for a sandbox project, used to test LARA & Interactives communication.

You can run the sanbox on the github pages site.

Developing:

  • checkout the code from github
  • npm install to install deps
  • gulp will start watching source files in ./src and will build to the ./dev directory
  • edit files in ./src
  • run cd ./dev && live-server to watch your changes in the browser

Deploying:

Dry run

  • run gulp build-all --production && mkdocs build this will create dist files in ./dist
  • run cd ./dist && live-server to check your work.

Update github pages

When satisfied with the state of ./dist run ./build.sh from the root directory of this project. This will attempt to push changes up to the gh-pages branch of this project which you shouldn't change by hand

Documenation

The existing API documenation can be edited in ./docs/.. When writing documenation use mkdocs serve to see a live preview it at http://localhost:8000

When the build is complete, the gh-pages documenation at http://concord-consortium.github.io/lara-interactive-api will also be updated.

TODO:

  • Add RPC testing โ€ฆ

LICENSE:

Available under the MIT License.

lara-interactive-api's People

Contributors

dougmartin avatar knowuh avatar pjanik avatar scytacki 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.