UniWebPlatform

Introduction

A full-stack web application for my personal website, featuring:

1. AI Studio
2. Markdown-based Blogs
3. Password Generator & AES Enctyption / Decryption

Tech Stack

• Front End: Node.js, React.js, Next.js, Tailwind CSS, MUI
• Back End: Node.js (Nest.js), Python (FastAPI)
• Storage: MySQL, MinIO, Redis
• Authentication: Firebase (Email Verification)
• Infrastructure: Linux (Debian 12), Kubernetes (K3S), Nginx
• DevOps: GitHub Actions

Live Demo

https://www.windsnow1025.com

Setup

Prepare Environment

1. Copy ./app-secret.example.yaml to ./app-secret.yaml and ./app-secret-test.yaml, modify value for each key.

Debian Production

Log in as root user

Set Config and Environment

1. Compress ./kubernetes to ./kubernetes.zip
2. Run

   mkdir /root/kubernetes

3. Install Dependencies

   apt update
   apt install unzip

4. Upload ./kubernetes.zip to /root/kubernetes/
5. Create Configs

   cd /root/kubernetes
   unzip kubernetes.zip
   rm kubernetes.zip
   mv kubernetes UniWebPlatform
   cd UniWebPlatform/

K3S Installation and Configuration

See ./K3S.md

Apply Custom Configs

See ./KubernetesCommand.md

Nginx (Optional)

HTTP Block:

server {

	server_name <domain_name>;

	client_max_body_size 100M;

    location / {
        proxy_pass http://localhost:30080/;
        
        proxy_buffering off;
        proxy_request_buffering off;

        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Port $server_port;
        proxy_set_header X-Forwarded-Host $host;

        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }

    location /kubernetes/ {
        proxy_pass https://localhost:38443/;

        proxy_ssl_verify off;

        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Port $server_port;
        proxy_set_header X-Forwarded-Host $host;
    }
}

Stream Block:

stream {
    server {
        listen 3306;
        proxy_pass localhost:33306;
    }
}

Usage

• Main: http://localhost:30080/
• MinIO: http://localhost:30080/minio/ui/
• Kubernetes Dashboard: https://localhost:38443/

Development

Windows Develop Environment

1. Setup and run MySQL and MinIO by K3S in Test Server.
2. Setup and run Next, Nest, FastAPI separately by JetBrains IDE according to their documentations.

CI/CD

GitHub >> Repository >> Settings >> Security >> Secrets and variables >> Actions >> Repository secrets: add

• DOCKERHUB_TOKEN
• DOCKERHUB_USERNAME

Make Contributions

We welcome contributions! Please follow these steps:

Contributor Workflow:

1. Create a Branch: Create a new branch based on main (e.g., feat/xxx).
2. Commit Changes: Develop your feature and commit changes to the new branch.
3. Open a Pull Request (PR): Submit a PR targeting the test branch and wait for review.

Repository Owner Workflow:

1. Deploy to Test Environment: The repository owner will deploy the changes to the test server via the Kubernetes Dashboard.
2. Verify in Test Environment: The repository owner will test the changes in the test environment.
3. Merge to Production: If everything works as expected, the repository owner will merge test into main.
4. Deploy to Production: The repository owner will manually restart the deployment in the production server via the Kubernetes Dashboard.