https://github.com/primeqa/primeqa-ui

Front-end for PrimeQA services
https://github.com/primeqa/primeqa-ui

Last synced: 8 months ago
JSON representation

Front-end for PrimeQA services

• Host: GitHub
• URL: https://github.com/primeqa/primeqa-ui
• Owner: primeqa
• License: apache-2.0
• Created: 2022-10-13T17:44:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T16:21:17.000Z (almost 3 years ago)
• Last Synced: 2025-03-26T11:21:45.375Z (about 1 year ago)
• Language: JavaScript
• Size: 662 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




    



 


# Tooling UI        




[![LICENSE|Apache2.0](https://img.shields.io/github/license/saltstack/salt?color=blue)](https://www.apache.org/licenses/LICENSE-2.0.txt)

✔️ Getting Started
 


- [Repository](https://github.com/primeqa/primeqa-ui)        

- This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)   

✅ Prerequisites


- [Yarn](https://classic.yarnpkg.com/en/docs/install)

🧩 Setup Local Environment


- Dowload all necessary packages to build and deploy the application: `yarn install`        

- Open `.env` files and set `REACT_APP_API_URL` to point to services:        

    - local: [http://localhost:{PORT}](http://localhost:{PORT})      

💻 Run Locally


- Run the app in the _*development mode*_: `yarn start`        

- Open [http://localhost:8888](http://localhost:8888) to view it in the browser.               

💻 Setup & Run Docker
      


This allows us to run the build in a node image and server the app using an nginx image.        

The final Docker image will just contain the build folder and nothing else      

(the project files were only used by to build the project in the builder layer, which then gets thrown away)      

it's just an intermmediary step.        

- `docker build . -t primeqa_ui`       

- `docker run --rm --name primeqa_ui -d -p 82:82 primeqa_ui:$(cat VERSION)`              

    - 82 -> public port to access     

    - 82 -> container expose port  

- stop container: `docker stop  primeqa_ui`        

- remove container: `docker rm primeqa_ui`     

- remove image: `docker rmi primeqa_ui`        

📄 Documentation Sync
      


**Keep PrimeQA documentation reference sync**   

Anytime this README files is updated, it is necessary to open a PR on PrimeQA repository to update, with the same modifications, **[the associated file](https://github.com/primeqa/primeqa/blob/main/docs/tooling_ui.md)** used on [documentation page](https://primeqa.github.io/primeqa/tooling_ui.html).        

*Do not modify initial image path*