Rename binary and artifact names to cdn

TOwInOK · TOwInOK · commit f46f60608093 · 2025-11-03T01:42:20.000+07:00
Also, change the binary name in the workflows and examples.
diff --git a/.github/workflows/cli.yml b/.github/workflows/cli.yml
@@ -11,7 +11,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  BINARY_NAME: change_me
+  BINARY_NAME: cdn
 
 jobs:
   lint:
@@ -46,38 +46,38 @@ jobs:
           # linux x64
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            artifact_name: change_me
-            asset_name: change_me-linux-amd64
+            artifact_name: cdn
+            asset_name: cdn-linux-amd64
 
           # linux arm
           - os: ubuntu-latest
             target: aarch64-unknown-linux-gnu
-            artifact_name: change_me
-            asset_name: change_me-linux-arm
+            artifact_name: cdn
+            asset_name: cdn-linux-arm
 
           # windows x64
           - os: windows-latest
             target: x86_64-pc-windows-gnu
-            artifact_name: change_me.exe
-            asset_name: change_me-windows-amd64.exe
+            artifact_name: cdn.exe
+            asset_name: cdn-windows-amd64.exe
 
           # windows arm
           - os: windows-latest
             target: aarch64-pc-windows-msvc
-            artifact_name: change_me.exe
-            asset_name: change_me-windows-arm.exe
+            artifact_name: cdn.exe
+            asset_name: cdn-windows-arm.exe
 
           # macos x64
           - os: macos-latest
             target: x86_64-apple-darwin
-            artifact_name: change_me
-            asset_name: change_me-macos-amd64
+            artifact_name: cdn
+            asset_name: cdn-macos-amd64
 
           # macos arm
           - os: macos-latest
             target: aarch64-apple-darwin
-            artifact_name: change_me
-            asset_name: change_me-macos-arm
+            artifact_name: cdn
+            asset_name: cdn-macos-arm
 
     steps:
       - uses: actions/checkout@v4
@@ -144,12 +144,12 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           files: |
-            change_me-linux-amd64/change_me-linux-amd64
-            change_me-windows-amd64.exe/change_me-windows-amd64.exe
-            change_me-macos-amd64/change_me-macos-amd64
-            change_me-linux-arm/change_me-linux-arm
-            change_me-windows-arm.exe/change_me-windows-arm.exe
-            change_me-macos-arm/change_me-macos-arm
+            cdn-linux-amd64/cdn-linux-amd64
+            cdn-windows-amd64.exe/cdn-windows-amd64.exe
+            cdn-macos-amd64/cdn-macos-amd64
+            cdn-linux-arm/cdn-linux-arm
+            cdn-windows-arm.exe/cdn-windows-arm.exe
+            cdn-macos-arm/cdn-macos-arm
           draft: false
           prerelease: false
           generate_release_notes: true
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -8,7 +8,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  BINARY_NAME: change_me
+  BINARY_NAME: cdn
 
 jobs:
   lint:
diff --git a/README.md b/README.md
@@ -1,36 +1,83 @@
-# rust-template-default
-Default project template for rust project with my credentials
+# DDNet Tee Generator CDN
 
-# Contains
-- CI/CD pipeline on tag `v*.*.*`
-- CI link on every push
-- Test folder
-- License (MIT)
-- .env file
-- Configurated Cargo.toml
-- Configurated .gitignore
-- Configurated rust-toolchain.toml
-- Configurated rustfmt.toml
+This project serves as a Content Delivery Network (CDN) for DDNet (DDrace Network) tee skins. It's designed to generate custom tee skins on demand, cache them for performance, and synchronize with official DDNet skin repositories.
 
----
+## Description
 
-# Name of packet
+The DDNet Tee Generator CDN provides an API to create and serve custom tee skins for the DDraceNetwork game. It allows users to specify skin parameters like name, body color, and feet color to generate unique tee appearances. The system leverages caching to serve frequently requested skins quickly and synchronizes with DDNet's official skin sources to maintain an up-to-date collection.
 
-## Description
+## Routes
+
+The following API routes are available:
+
+*   **`GET /skin`**
+    *   **Description**: Generates and returns a custom tee skin based on the provided query parameters.
+    *   **Query Parameters**:
+        *   `name`: (String, **Required**) The name of the skin. Whitespaces are replaced with underscores.
+        *   `body`: (u32, Optional) The DDNet color value for the tee's body.
+        *   `feet`: (u32, Optional) The DDNet color value for the tee's feet.
+
+*   **`GET /skin/store`**
+    *   **Description**: Returns a JSON array of the names of all currently stored (downloaded and synchronized) skins.
+
+*   **`GET /skin/cache`**
+    *   **Description**: Returns a JSON array of the names of all currently cached (generated) skins.
+
+*   **`GET /uvs`**
+    *   **Description**: Serves a folder containing all UV (unwrap) images. This route acts as a mirror for the UV data.
+
+*   **`GET /health`**
+    *   **Description**: Performs a health check and returns a `204 No Content` response if the service is operational.
+
+*   **`GET /doc`**
+    *   **Description**: Serves the OpenAPI documentation for the API.
+
+## Created Folders
+
+The application creates and utilizes the following folders:
+
+*   `static/`: Store generated scalar doc `doc.html`.
+*   `.cache/`: Used for storing generated tee skins to prevent redundant computations. These cached skins have a TTL (Time To Live) of 15 minutes.
+*   `.store/`: Contains the downloaded base skin images from DDNet sources and a `lock.json` file which tracks metadata about these stored skins.
+
+## Examples of Requests
+
+Here are examples of how to interact with the API:
+
+*   **Generate a skin named "my_custom_tee" with specific body and feet colors:**
+    ```
+    GET /skin?name=my_custom_tee&body=322&feet=322
+    ```
+
+*   **Generate a skin named "another_tee" with only a name:**
+    ```
+    GET /skin?name=another_tee
+    ```
+
+*   **Get a list of all stored skins:**
+    ```
+    GET /skin/store
+    ```
 
-## How to use
-```sh
+*   **Get a list of all cached skins:**
+    ```
+    GET /skin/cache
+    ```
 
-```
+*   **Check the health of the service:**
+    ```
+    GET /health
+    ```
 
-## Examples
+*   **Access the API documentation:**
+    ```
+    GET /doc
+    ```
 
-## How to build
-```sh
-git clone repo-url
-cd repo-name
-cargo build
-```
+*   **Access the UV images:**
+    ```
+    GET /uvs
+    ```
 
 ## License
 MIT License
diff --git a/src/app/skin.rs b/src/app/skin.rs
@@ -27,10 +27,13 @@ pub fn skin_router() -> Ohkami {
 }
 
 #[derive(Debug, Clone, Deserialize, Schema, Hash, PartialEq, Eq, Serialize)]
+/// Base/Default/Main skin query
 pub struct SkinQuery {
     /// Replace all whitespaces to `_`
     pub name: String,
+    /// DDNet value
     pub body: Option<u32>,
+    /// DDNet value
     pub feet: Option<u32>,
 }
 
diff --git a/src/main.rs b/src/main.rs
@@ -19,7 +19,7 @@ fn init_logger(level: Level) {
 
     // Check for RUST_LOG env var, default to INFO if not present
     let env_filter = EnvFilter::try_from_default_env()
-        .unwrap_or_else(|_| EnvFilter::new("cdn=trace,ohkami=trace"));
+        .unwrap_or_else(|_| EnvFilter::new("cdn=info,ohkami=trace"));
 
     let fmt_layer = fmt::layer().compact().with_ansi(true).with_target(true);
 

Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,13 @@ pub fn skin_router() -> Ohkami {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`#[derive(Debug, Clone, Deserialize, Schema, Hash, PartialEq, Eq, Serialize)]`
	`30`	`+/// Base/Default/Main skin query`
`30`	`31`	`pub struct SkinQuery {`
`31`	`32`	/// Replace all whitespaces to `_`
`32`	`33`	`pub name: String,`
	`34`	`+ /// DDNet value`
`33`	`35`	`pub body: Option<u32>,`
	`36`	`+ /// DDNet value`
`34`	`37`	`pub feet: Option<u32>,`
`35`	`38`	`}`
`36`	`39`