Giter VIP home page Giter VIP logo

krakendesigner's Introduction

KrakenDesigner

A visual editor for the KrakenD configuration file.

An application made with AngularJS to visually create the krakend.json file.

Usage

There are different ways of using the Designer:

  • Use its hosted version online. Your configurations are not uploaded elsewhere.
  • Run a local container: docker run --rm -p 8000:80 krakend/designer
  • Clone the repo and build with NPM.

Important: Notice that when used locally, you cannot edit files as the HTML5 library used to access local files works only under HTTPS, but you can still download edited copies. Use Ngrok or a similar solution to serve under HTTPS locally.

The master branch of this repository is automatically built and pushed to the online version.

Build

The build process leaves a single html file and a single JS file in the designer folder that is later deployed inside the KrakenD images. Build with:

Via docker

If you have Docker this is the cleanest solution to download the dependencies, generates the js file and deletes the node_modules folder:

 make

Locally with npm

If you don't have Docker, you can see your local npm to install the dependencies and build the project:

npm install
npm run-script build

Testing changes

Start the web server pointing to designer/ and mounting the volume:

docker run --rm -d -p 8000:80 -v "$PWD/designer:/usr/share/nginx/html" krakend/designer

Remember to make build or make watch if you change HTML, CSS or JS.

Get involved! - Please!

The application is working properly (if you find any bug please create an issue) but it needs love from frontend specialists. If you think the application needs reorganization, refactoring, webpack plugins or even a full rewrite in another framework please help us make it improve. We do know how to write go, stuff about performance, and all the boring stuff. Javascript is for decent people (and that probably leave us out), so we need you!

krakendesigner's People

Contributors

alombarte avatar dependabot[bot] avatar kpacha avatar neokeld avatar obokaman-com avatar taik0 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.