- 🎙️ About Carecaokê
- 🎉 What is this API ?
- 🎵 Features
- 🔨 Development mode and Unit testing
- 🌿 Env variables
- 🐙 GitHub Actions
- ©️ License
- ❤️ Contributors
When singing, some people feel like they are exposing part of their soul. I'm one of those people. In these moments, there is nothing more comforting than knowing that, in addition to enjoying singing, others enjoyed listening. Therefore, Carecaokê aims to not only bring this instant feedback but also enable a fun game between friends, in this special moment. Gather your friends, sing, be happy!
Hey now, you're an all star
Get your game on, go play
Hey now, you're a rock star
Get the show on, get paid
And all that glitters is gold
Only shooting stars break the mold
-- Smash Mouth - All Star
Embrace singing competition!
Carecaokê API provides over HTTP requests a way of manage the singing competition.
It's a Backend application to support your competition.
- Managing your party Guests
- Managing all sung songs
- Managing votes
- Generate ratings
- Listing all results
- Controlling list of songs to sing and call the next song
- Preventing singers from voting for themselves
- Allowing guests to manage only their own music and votes
This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ . We suggest you configure your preferred Java IDE. Remember that you will also need to configure adapters for the Quarkus framework. For unit tests, we aim to ensure maximum coverage in the controller and service classes. Run them using your IDE.
You can run your application in dev mode that enables live coding using:
./mvnw compile quarkus:devNOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
The application can be packaged using:
./mvnw packageIt produces the quarkus-run.jar file in the target/quarkus-app/ directory.
Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.
The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.
If you want to build an über-jar, execute the following command:
./mvnw package -Dquarkus.package.type=uber-jarThe application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.
You can create a native executable using:
./mvnw package -DnativeOr, if you don't have GraalVM installed, you can run the native executable build in a container using:
./mvnw package -Dnative -Dquarkus.native.container-build=trueYou can then execute your native executable with: ./target/carecaoke-1.0.0-SNAPSHOT-runner
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
- Hibernate ORM (guide): Define your persistent model with Hibernate ORM and Jakarta Persistence
- JDBC Driver - H2 (guide): Connect to the H2 database via JDBC
- RESTEasy Reactive (guide): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
Environnement variables are available in a secret file at folder resources. File name must be secret.properties.
Environment variables are :
| Name | Description | Required |
|---|---|---|
quarkus.datasource.username |
Your database credential username | ✅ |
quarkus.datasource.password |
Your database credential password | ✅ |
This project uses GitHub Actions to automate some tasks and reduce toil.
You can find all the workflows in the .github/workflows directory.
| Name | Description & Status | Triggered on |
|---|---|---|
| ⚙️ Build | Build the application and runs all Unit Tests | push on develop and all pull requests to develop |
This project is licensed under the Apache License, Version 2.0.
