Viron
OAS-driven Frontend-NoCode Administration Console
Install / Use
/learn @cam-inc/VironREADME
<div align="center">
<img src="./arts/title.png" style="width:50%;" />
</div>
<h2 align="center">OAS-driven Frontend-NoCode Administration Console</h2>
📣 Notice of Repository Structure Change
The Golang component has been migrated to a separate repository (viron-go). If you are using the Go implementation, please refer to that repository.
This change provides the following benefits:
- Separation and optimization of development and CI/CD flows for Node.js and Go
- Improved flexibility for updates and releases for each language
- A more understandable structure for contributors
User Interface
<div align="center"> <img src="./arts/responsive/desktop.png" align="top" style="width:70%;" /> <img src="./arts/responsive/mobile.png" align="top" style="width:25%;" /> </div> <br /> <div align="center"> <img src="./arts/ui/nav.png" align="top" style="width:15%;" /> <img src="./arts/ui/form.png" align="top" style="width:25%;" /> <img src="./arts/ui/modal.png" align="top" style="width:20%;" /> </div> <br /> <div align="center"> <img src="./arts/ui/table.png" align="top" style="width:50%;" /> </div> <br /> <div align="center"> <img src="./arts/ui/app_bar.png" align="top" style="width:30%;" /> <img src="./arts/ui/endpoint_card.png" align="top" style="width:30%;" /> <img src="./arts/ui/info.png" align="top" style="width:30%;" /> </div> <br /> <div align="center"> <img src="./arts/theme/c_1.png" align="top" style="width:15%;" /> <img src="./arts/theme/c_2.png" align="top" style="width:15%;" /> <img src="./arts/theme/c_3.png" align="top" style="width:15%;" /> <img src="./arts/theme/c_4.png" align="top" style="width:15%;" /> <img src="./arts/theme/c_5.png" align="top" style="width:15%;" /> </div> <br /> <div align="center"> <img src="./arts/theme/p_1.png" align="top" width="40%"/> <img src="./arts/theme/p_2.png" align="top" width="40%"/> <img src="./arts/theme/p_3.png" align="top" width="40%"/> <img src="./arts/theme/p_4.png" align="top" width="40%"/> <img src="./arts/theme/p_5.png" align="top" width="40%"/> <img src="./arts/theme/p_6.png" align="top" width="40%"/> </div>What is Viron
Viron is a web-based administration tool, which
- is based on and leverages OpenAPI Specification,
- offers Frontend-Node console with fine-tuned GUI,
- and is an Open-Source Software.
Viron enables you to eliminate all the Frontend-matter tasks when administrating your API servers.
The Idea
OpenAPI Specification, a.k.a. OAS, is a YAML or JSON file that defines an interface to a set of RESTful APIs. By interpreting an OAS document, the readers understand things such as:
- The overall idea for the APIs.
- How to call a particular API.
- How to construct request payloads.
- What type of schema do the APIs return.
- The ways to authenticate.
- And much more.
Viron evaluates and leverages OAS documents, interprets those above, and then constructs a GUI for you.
Viron is For Those Who
- have a
RESTfuladministration API server. - do not have time to make an administration website
from scratch. - have good knowledge of OpenAPI Specification.
Viron is NOT For Those Who
- require a complex administration website that an OAS document
can not define. - have a GraphQL administration API server.
