jeffreysjauwmook / apicurito

A small/minimal version of Apicurio used for standalone editing of API designs.

Home Page:https://www.apicur.io/apicurito/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Verify Build

Apicurito (Apicurio Lite)

This project was generated with Angular CLI version 1.6.8.

Development server

Before running the dev server you must install node and yarn. Once these tools are installed you must run yarn install to download all of the project's dependencies from ui folder.

Run ng serve from ui folder for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

To run on a different port, try ng serve --port 8888 for example. And if you want AOT enabled, you can run ng serve --aot --port 8888.

Testing Service Worker

The service worker is disabled for development builds but can still be easily tested locally.

From the ui folder, first run npm run build or ng build --prod to build the production app. Then serve the dist folder with any web server on a different port from the dev server, and with caching disabled. The simplest way to do this is: npx http-server -p 8080 -c-1 dist

You can also check out the Angular docs for more detailed docs.

Running On Openshift

This will try to pull down the Apicurito image from container registries:

oc replace --force  -f openshift.yml

But if you want that configuration changed so that it uses local builds, run:

./openshift-dev.sh

And build the image using:

mvn install -P image    

And if you have deployed the fuse-apicurito-generator into the current project, then run the following to configure Apicurito to use it.

./enable-fuse-generator.sh 

Publishing the Image

mvn clean install -P image -Dfabric8.mode=kubernetes
docker push apicurio/apicurito-ui:latest

About

A small/minimal version of Apicurio used for standalone editing of API designs.

https://www.apicur.io/apicurito/

License:Apache License 2.0


Languages

Language:TypeScript 59.2%Language:HTML 27.3%Language:CSS 5.1%Language:Shell 2.7%Language:Dockerfile 2.0%Language:Go 2.0%Language:Makefile 1.3%Language:JavaScript 0.4%