Skip to content
@Project-Smoodi

Project Smoodi

The framework

You can switch branches to view documents in different languages.

Korean Docs | English Docs


Smoodi Banner

Project Smoodi - The Framework

by Daybreak312


What is Smoodi?

Smoodi is a Java enterprise-based framework for building web application servers.

It provides the foundational infrastructure needed to run applications, enabling developers to focus solely on business logic.

Smoodi aims to deliver a streamlined and highly productive development environment.


Getting Started


Adding Smoodi Dependencies

To add Smoodi to your project, include the following dependency in your dependencies block.

Replace version with the desired Smoodi version.


Groovy (build.gradle)

dependencies {
  implementation 'org.smoodi.framework:smoodi-web:version'
}

Kotlin DSL (build.gradle.kts)

dependencies {
  implementation("org.smoodi.framework:smoodi-web:version")
}

Configuring the Smoodi Repository

Smoodi is distributed via GitHub Packages.

Add the repository to your repositories block.


Groovy (build.gradle)

repositories {
    maven {
        name = 'GitHubPackages'
        url = 'https://maven.pkg.github.com/Project-Smoodi/Smoodi-Core'
        credentials {
            username = project.findProperty('gpr.user') // GitHub username, set via Gradle properties
            password = System.getenv('TOKEN') // GHP token with 'read:packages' permission, set via environment variables
        }
    }
    mavenCentral() // Include if you need dependencies from Maven Central.
}

Kotlin DSL (build.gradle.kts)

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/Project-Smoodi/Smoodi-Core")
        credentials {
            username = project.findProperty("gpr.user") // GitHub username, set via Gradle properties
            password = System.getenv("TOKEN") // GHP token with 'read:packages' permission, set via environment variables
        }
    }
    mavenCentral() // Include if you need dependencies from Maven Central.
}

The credentials section provides authentication for accessing GitHub Packages.

  • username: Your GitHub username.
  • password: A GitHub token (GHP token) with the read:packages permission.

⚠️ Security Tip: Avoid hardcoding credentials. Use Gradle properties (gradle.properties) or system environment variables for security.

For details on generating a GHP token, refer to the GitHub documentation.


Running Gradle

Once the dependencies are configured, download them by running the following command in your project’s root directory:

./gradlew 

Pinned Loading

  1. Smoodi-Web Smoodi-Web Public

  2. Smoodi-Core Smoodi-Core Public

    The core framework of Smoodi

    Java 1

Repositories

Showing 5 of 5 repositories
  • Project-Smoodi.github.io Public

    The docs

    Project-Smoodi/Project-Smoodi.github.io’s past year of commit activity
    JavaScript 0 0 0 0 Updated Dec 19, 2024
  • Smoodi-Core Public

    The core framework of Smoodi

    Project-Smoodi/Smoodi-Core’s past year of commit activity
    Java 1 Apache-2.0 0 0 0 Updated Dec 18, 2024
  • .github Public
    Project-Smoodi/.github’s past year of commit activity
    0 0 0 0 Updated Nov 25, 2024
  • Smoodi-Web Public
    Project-Smoodi/Smoodi-Web’s past year of commit activity
    0 Apache-2.0 0 0 0 Updated Nov 25, 2024
  • Docs-Annotations Public

    The annotation set library for documentation

    Project-Smoodi/Docs-Annotations’s past year of commit activity
    Java 0 Apache-2.0 0 0 0 Updated Sep 24, 2024

Top languages

Loading…

Most used topics

Loading…