Installation

NOTE: Currently, Quak has only been released as a 1.0-SNAPSHOT version hosted via GitHub packages. When Quak has a full non-snapshot release, it will be hosted on maven central. Because Quak is only available on GitHub packages, you'll need extra setup beyond adding dependencies to your project's pom.xml.

Use the Quak CLI to start the project using the quak-cli create command. This will prompt you to give an artifact ID, group ID, and a template to use. Alternatively, use the steps below:

1. Add the appropriate Quak modules as maven dependencies in your project's pom.xml. See the project GitHub packages for more details.
2. In your pom.xml, add the following repositories:

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/john-amiscaray/QuakFramework</url>
    </repository>
</repositories>

<pluginRepositories>
    <pluginRepository>
        <id>github</id>
        <url>https://maven.pkg.github.com/john-amiscaray/QuakFramework</url>
    </pluginRepository>
</pluginRepositories>

3. In your GitHub developer settings, generate a classic personal access token with at least the read:packages permission enabled.
4. In your maven settings file (located in ~/.m2/settings.xml) add the following to authenticate with GitHub packages:

<servers>
    <server>
        <id>github</id>
        <username>Your GitHub Username</username>
        <password>Your GitHub Personal Access Token</password>
    </server>
</servers>

If you are using a settings.xml file from your ~/.m2 folder, be sure to update your Maven settings in IntelliJ as follows: