From 762385d3a5bbf619f8d1318eccd31c1bfc8a6a93 Mon Sep 17 00:00:00 2001 From: Max Nanis Date: Fri, 27 Jun 2025 19:02:36 +0700 Subject: README and LICENSE to repo --- LICENSE | 21 +++++++++++ README.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/api/README.md | 6 ++-- 3 files changed, 125 insertions(+), 4 deletions(-) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6d91d59 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 General Research Laboratories, LLC + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..de05150 --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +# [Panel UI](https://github.com/GRL/panel-ui) · [![license](https://cdn.generalresearch.com/buildStatus/icon?subject=license&status=MIT&color=blue)](./LICENSE) ![](https://github.com/facebook/react/blob/main/LICENSE) [![master](https://cdn.generalresearch.com/buildStatus/icon?subject=master&job=panel-ui%2Fmaster)](https://cdn.generalresearch.com/grl-panel.js) ![nodejs](https://cdn.generalresearch.com/buildStatus/icon?subject=node&status=20.19.2&color=blue) ![npm](https://cdn.generalresearch.com/buildStatus/icon?subject=npm&status=11.4.2&color=blue) + +### General Research Supplier and Panel Interface + +This project provides various front-end React components that leverage the General +Research [Full-Service Brokerage API](https://fsb.generalresearch.com/redoc/). There are no private API calls or +functionality. + +## Integration Example + +```js + +``` + +## Build Status and Content Delivery + + + + + + + + + + + + + + +
BranchesVersions
+ + + + + + + +
+ + + + + + + +
+ +Please click on the build status badges to access the CDN hosted javascript for you to use. + +## How to build your own Panel UI + +### Running Development + +``` +npm install +npm dev +``` + +### Building Production + +``` +npm install +npm build +``` + +If successful, a single file will be generaged at `/dist/grl-panel.js` which you can then use to place on your own CDN +or web server. + +## API Documentation and Interfaces + +A design pattern and goal of the Panel UI project is to not use any proprietary or custom models or object definitions +within the project itself. By leveraging [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli) +all the required models and API endpoints can be built from the General +Research [https://fsb.generalresearch.com/redoc/](FSB Documentation) openapi +file [available here](https://fsb.generalresearch.com/openapi.json). + +This project contains the prebuilt interfaces and endpoint classes for the API. However, instructions to build it +yourself is available in the [@/src/api/README.md](./src/api/README.md) file. + +## License + +Panel UI is [MIT licensed](./LICENSE). + +> *Do what you want, just give credit.* \ No newline at end of file diff --git a/src/api/README.md b/src/api/README.md index 8eed370..4f38b66 100644 --- a/src/api/README.md +++ b/src/api/README.md @@ -1,5 +1,6 @@ +# Panel UI OpenAPI Definitions -``` +```bash brew install openjdk export PATH="/opt/homebrew/opt/openjdk/bin:$PATH" export CPPFLAGS="-I/opt/homebrew/opt/openjdk/include" @@ -7,9 +8,6 @@ export CPPFLAGS="-I/opt/homebrew/opt/openjdk/include" source ~/.zshrc # or source ~/.bash_profile java -version - - wget https://fsb.generalresearch.com/openapi.json - openapi-generator-cli generate -i ./openapi.json -g typescript-axios -o ./ ``` \ No newline at end of file -- cgit v1.2.3