Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quarkiverse/quarkus-quinoa

Quinoa is a Quarkus extension which eases the development, the build and serving of single page apps (built with NodeJS: React, Angular, …) alongside Quarkus . It is possible to use it with a Quarkus backend in a single project
https://github.com/quarkiverse/quarkus-quinoa

angular frontend quarkus quarkus-extension react vue web

Last synced: 2 days ago
JSON representation

Quinoa is a Quarkus extension which eases the development, the build and serving of single page apps (built with NodeJS: React, Angular, …) alongside Quarkus . It is possible to use it with a Quarkus backend in a single project

Awesome Lists containing this project

README 

        




 

# Quarkus Quinoa







[![Maven Central](https://img.shields.io/maven-central/v/io.quarkiverse.quinoa/quarkus-quinoa.svg?label=Maven%20Central)](https://search.maven.org/artifact/io.quarkiverse.quinoa/quarkus-quinoa)

[![Build](https://github.com/quarkiverse/quarkus-quinoa/actions/workflows/build.yml/badge.svg)](https://github.com/quarkiverse/quarkus-quinoa/actions/workflows/build.yml) 

[![Issues](https://img.shields.io/github/issues/quarkiverse/quarkus-quinoa)](https://github.com/quarkiverse/quarkus-quinoa/issues) 

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



[![All Contributors](https://img.shields.io/badge/all_contributors-30-orange.svg?style=flat-square)](#contributors-)



Quinoa is a Quarkus extension which eases the development, the build and serving of single page apps or web components (built with [npm](https://docs.npmjs.com/) : [React](https://react.dev/learn), [Angular](https://angular.dev/overview), [Vue](https://vuejs.org/guide/introduction.html), [Lit](https://lit.dev/), [Svelte](https://svelte.dev/docs/introduction), [Astro](https://docs.astro.build/en/getting-started/), [SolidJS](https://www.solidjs.com/guides/getting-started) …) alongside [Quarkus](https://quarkus.io/). It is possible to use it with a Quarkus backend in a single project.



You will be able to do live coding of the backend and frontend together nearly out of the box. In Quarkus dev mode, Quinoa will start the node live coding server provided by the target framework and forward relevant requests to it.



## Versioning



There are multiple versions available please check which one for your Quarkus release version.



| Extension Version | Quarkus Version |

| --- | --- |

| ![1.x](https://img.shields.io/maven-central/v/io.quarkiverse.quinoa/quarkus-quinoa?versionPrefix=1.&color=cyan) | [![Quarkus](https://img.shields.io/badge/Quarkus-2.0+-purple.svg)](https://github.com/quarkusio/quarkus/releases/tag/2.16.6.Final) |

| ![2.2.x](https://img.shields.io/maven-central/v/io.quarkiverse.quinoa/quarkus-quinoa?versionPrefix=2.2&color=cyan) | [![Quarkus](https://img.shields.io/badge/Quarkus-3.2+-purple.svg)](https://github.com/quarkusio/quarkus/releases/tag/3.2.0.Final) |

| ![2.3.x](https://img.shields.io/maven-central/v/io.quarkiverse.quinoa/quarkus-quinoa?versionPrefix=2.3&color=cyan) | [![Quarkus](https://img.shields.io/badge/Quarkus-3.8+-purple.svg)](https://github.com/quarkusio/quarkus/releases/tag/3.8.0) |

| ![latest](https://img.shields.io/maven-central/v/io.quarkiverse.quinoa/quarkus-quinoa?&color=cyan) | [![Quarkus](https://img.shields.io/badge/Quarkus-3.12+-purple.svg)](https://github.com/quarkusio/quarkus/releases/tag/3.12.0) |



## Getting started



Read the full [Quinoa documentation](https://docs.quarkiverse.io/quarkus-quinoa/dev/index.html).



### Prerequisite



- Create or use an existing Quarkus application

- Add the Quinoa extension

- Install [NodeJS](https://nodejs.org/) or make sure Quinoa is [configured](https://docs.quarkiverse.io/quarkus-quinoa/dev/advanced-guides.html#package-manager) to install it.



### Installation



Create a new Quinoa project (with a base Quinoa starter code):



- With [code.quarkus.io](https://code.quarkus.io/?a=quinoa-bowl&j=17&e=io.quarkiverse.quinoa%3Aquarkus-quinoa)

- With the [Quarkus CLI](https://quarkus.io/guides/cli-tooling):



```bash

quarkus create app quinoa-app -x=io.quarkiverse.quinoa:quarkus-quinoa

```



Then start the live-coding:



```bash

quarkus dev

```



And navigate to http://0.0.0.0:8080/quinoa.html



You could also just add the extension (but you won't get the starter code):



- With the [Quarkus CLI](https://quarkus.io/guides/cli-tooling):



```bash

quarkus ext add io.quarkiverse.quinoa:quarkus-quinoa

```



## πŸ§‘β€πŸ’» Contributing



- Contribution is the best way to support and get involved in community!

- Please, consult our [Code of Conduct](./CODE_OF_CONDUCT.md) policies for interacting in our community.

- Contributions to `quarkus-quinoa` Please check our [CONTRIBUTING.md](./CONTRIBUTING.md)



### If you have any idea or question 🀷



- [Ask a question](https://github.com/quarkiverse/quarkus-quinoa/discussions)

- [Raise an issue](https://github.com/quarkiverse/quarkus-quinoa/issues)

- [Feature request](https://github.com/quarkiverse/quarkus-quinoa/issues)

- [Code submission](https://github.com/quarkiverse/quarkus-quinoa/pulls)



## Contributors ✨



Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



  

    

      Andy Damevin
Andy Damevin
πŸ’» 🚧

      Melloware
Melloware
πŸ’» 🚧

      Phillip KrΓΌger
Phillip KrΓΌger
πŸ’»

      Radim Vansa
Radim Vansa
πŸ’»

      Blanc Frederic
Blanc Frederic
πŸ’»

      andyhan
andyhan
πŸ’»

      Marvin Bredal Lillehaug
Marvin Bredal Lillehaug
πŸ’»

    

    

      John O'Hara
John O'Hara
πŸ’»

      Holly Cummins
Holly Cummins
πŸ“–

      Shivam Sharma
Shivam Sharma
πŸš‡ πŸ“– πŸ”£

      Ivan Milosavljević
Ivan Milosavljević
πŸ“–

      Alex Karezin
Alex Karezin
πŸ“–

      Thomas Sapelza
Thomas Sapelza
πŸ›

      Steffen Van
Steffen Van
πŸ“–

    

    

      Paul Dubs
Paul Dubs
πŸ“–

      Andrei Hava
Andrei Hava
πŸ›

      l2c0r3
l2c0r3
πŸ›

      stevenfuhr
stevenfuhr
πŸ›

      Leon Kirschner
Leon Kirschner
πŸ“–

      mbouhda
mbouhda
πŸ›

      mschorsch
mschorsch
πŸ›

    

    

      Yann Le Moigne
Yann Le Moigne
πŸ’»

      Alice
Alice
πŸ’» πŸ€”

      Yann-Thomas LE MOIGNE
Yann-Thomas LE MOIGNE
πŸ’»

      Jakob Maležič
Jakob Maležič
πŸ›

      Shamil Nunhuck
Shamil Nunhuck
πŸ›

      Georgios Andrianakis
Georgios Andrianakis
πŸ’»

      LoΓ―c Magnette
LoΓ―c Magnette
πŸ“–

    

    

      threadlock05
threadlock05
πŸ›

      Eric Deandrea
Eric Deandrea
πŸ›

    

  



This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!