feat: add documentation

Author: allansp84

docs/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @annotat3d/docs
+
+## 0.1.1
+
+### Patch Changes
+
+- Versioning latest patch to docs and app and adding automated server.

docs/Dockerfile

@@ -0,0 +1,38 @@
+# Base image
+FROM node:18-alpine AS base
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
+# Install dependencies
+FROM base AS deps
+RUN apk add --no-cache libc6-compat
+WORKDIR /app
+
+# Copy over files and install dependencies
+COPY . .
+RUN pnpm install
+
+# Build the app
+RUN pnpm run build
+
+# Prepare for production
+FROM base AS runner
+WORKDIR /app
+
+# Create nextjs user
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 nextjs
+
+# Create necessary directories with proper permissions
+RUN mkdir -p /app/.next/cache/images && chown -R nextjs:nodejs /app/.next
+
+# Set the user
+USER nextjs
+
+# Copy the app files from deps stage
+COPY --from=deps /app ./
+
+# Start the app
+CMD ["pnpm", "start"]
+

docs/FilenameTester.js

@@ -0,0 +1,86 @@
+"use client";
+
+import React, { useState } from 'react';
+
+function getRAFTVolumeInfoFromFilename(filename) {
+  const pattern = /([a-zA-Z0-9_\.\/\-]+)[a-zA-Z_\.\/\-0-9]*[_|\-]([0-9]+)x([0-9]+)x([0-9]+)[a-zA-Z_\.\/\-0-9]*[_|\-]([0-9]+)[b|bits|bit]|\.(b|raw)/;
+  const numpyPattern = /([a-zA-Z0-9_\.\/\-]+)[a-zA-Z_\.\/\-0-9]*[_|\-]([0-9]+)x([0-9]+)x([0-9]+)[a-zA-Z_\.\/\-0-9]*[_|\-](int8|uint8|int16|uint16|int32|uint32|float32|complex64)|\.(b|raw)/;
+
+  let xsize = null, ysize = null, zsize = null, dtype = null;
+
+  // First match the pattern with bit size, such as 32bits
+  let match = filename.match(pattern);
+  if (match !== null) {
+    try {
+      zsize = parseInt(match[4]);
+      ysize = parseInt(match[3]);
+      xsize = parseInt(match[2]);
+
+      // Convert bits to dtype
+      const bits = parseInt(match[5]);
+      if (bits === 8) dtype = 'uint8';
+      else if (bits === 16) dtype = 'uint16';
+      else if (bits === 32) dtype = 'float32';
+      else if (bits === 64) dtype = 'complex64';
+    } catch (e) {}
+  }
+
+  // If xsize, ysize, zsize, or dtype is still null, use numpy-like pattern
+  if (xsize === null || ysize === null || zsize === null || dtype === null) {
+    match = filename.match(numpyPattern);
+    if (match !== null) {
+      try {
+        zsize = parseInt(match[4]);
+        ysize = parseInt(match[3]);
+        xsize = parseInt(match[2]);
+        dtype = match[5]; // directly matches int8, float32, etc.
+      } catch (e) {}
+    }
+  }
+
+  return { xsize, ysize, zsize, dtype };
+}
+
+export default function FilenameTester() {
+  const [filename, setFilename] = useState('');
+  const [result, setResult] = useState({ xsize: null, ysize: null, zsize: null, dtype: null });
+
+  const handleTest = () => {
+    const info = getRAFTVolumeInfoFromFilename(filename);
+    setResult(info);
+  };
+
+  return (
+    <div>
+      <h3>Test Raw Parsing</h3>
+      <input
+        type="text"
+        value={filename}
+        onChange={(e) => setFilename(e.target.value)}
+        placeholder="Enter filename"
+        style={{ padding: '8px', fontSize: '16px', width: '300px', marginBottom: '10px', backgroundColor: '#cedaed' }}
+      />
+      <br />
+      <button
+        onClick={handleTest}
+        style={{
+          padding: '10px 10px',
+          backgroundColor: '#4CAF50',
+          color: 'white',
+          border: 'none',
+          borderRadius: '5px',
+          fontSize: '16px',
+          cursor: 'pointer',
+          transition: 'background-color 0.3s',
+        }}
+        onMouseOver={(e) => (e.target.style.backgroundColor = '#45a049')}
+        onMouseOut={(e) => (e.target.style.backgroundColor = '#4CAF50')}
+      >
+        Test
+      </button>
+      <p>
+        X size: {result.xsize}, Y size: {result.ysize}, Z size: {result.zsize}, data type: {result.dtype}
+      </p>
+    </div>
+  );
+}

docs/README.md

@@ -0,0 +1,82 @@
+# Project Setup Guide
+
+This guide provides instructions for setting up and running the project locally without Docker.
+
+## Prerequisites
+- Node.js 18+ (recommended to manage via nvm)
+- pnpm (package manager for Node.js)
+
+## Installation
+
+### Install nvm (Node Version Manager)
+
+Using nvm allows for easy management of multiple Node.js versions.
+
+#### Linux/macOS
+
+1. Install nvm:
+```sh
+curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash
+```
+
+2. Restart your terminal or run:
+```sh
+source ~/.bashrc
+```
+
+3. Install and use Node.js 18:
+```sh
+nvm install 18
+nvm use 18
+```
+
+## Runnig the project locally
+
+1. Clone the repository:
+```sh
+git clone <https://gitlab.cnpem.br/GCD/data-science/segmentation/annodocs.git>
+cd <annodocs>
+```
+
+2. Install dependencies and build the project:
+```sh
+pnpm install
+pnpm run build
+```
+
+### Development version
+
+3. Start the development server:
+```sh
+pnpm dev
+```
+
+4. Open the URL provided in the terminal (e.g., http://localhost:4321) in your browser.
+
+### Production version
+3. Build the project for production:
+```sh
+pnpm build
+```
+
+4. Determine your host IP address:
+```sh
+hostname -I 
+```
+
+5. Start the production server, specifying the host from the previous step and port of your choice:
+```sh
+PORT=4322 HOST=172.17.0.1 pnpm start
+```
+
+4. Open the provided URL (e.g., http://172.17.0.1:4322) in your browser.
+  
+
+## Learn More
+
+For further information, refer to the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) – Learn about Next.js features and APIs.
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) – Interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.vercel.app) – Interactive Next.js tutorial.