https://github.com/apicurio/apicurito

A small/minimal version of Apicurio used for standalone editing of API designs.
https://github.com/apicurio/apicurito

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/apicurio/apicurito
• Owner: Apicurio
• License: apache-2.0
• Created: 2018-08-20T18:18:26.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T03:20:18.000Z (almost 2 years ago)
• Last Synced: 2023-08-05T04:23:01.149Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://www.apicur.io/apicurito/
• Size: 5.86 MB
• Stars: 46
• Watchers: 6
• Forks: 27
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Verify Build](https://github.com/Apicurio/apicurito/workflows/Verify%20Build/badge.svg)

# Apicurito (Apicurio Lite)

This project was generated with [Angular CLI](https://github.com/angular/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](https://angular.io/guide/service-worker-getting-started)

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](https://github.com/jboss-fuse/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