{"id":29151138,"url":"https://github.com/azshurith/db2ui","last_synced_at":"2025-07-01T00:08:02.854Z","repository":{"id":301173556,"uuid":"1008371363","full_name":"Azshurith/DB2UI","owner":"Azshurith","description":"Auto-generate full-stack admin dashboards from your database schema. Powered by NuxtJS, Express, TypeScript, PostgreSQL, and Docker.","archived":false,"fork":false,"pushed_at":"2025-06-25T14:38:02.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-25T14:43:10.639Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azshurith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-25T12:47:23.000Z","updated_at":"2025-06-25T14:38:06.000Z","dependencies_parsed_at":"2025-06-25T14:43:34.265Z","dependency_job_id":"abcc6138-450a-490a-a988-39bb8d083d6c","html_url":"https://github.com/Azshurith/DB2UI","commit_stats":null,"previous_names":["azshurith/db2ui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Azshurith/DB2UI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azshurith%2FDB2UI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azshurith%2FDB2UI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azshurith%2FDB2UI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azshurith%2FDB2UI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azshurith","download_url":"https://codeload.github.com/Azshurith/DB2UI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azshurith%2FDB2UI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262870875,"owners_count":23377313,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T00:08:01.904Z","updated_at":"2025-07-01T00:08:02.728Z","avatar_url":"https://github.com/Azshurith.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 DB2UI\n\n\u003e Full-stack automation dashboard built with modern technologies — designed for scale, speed, and modularity.\n\nDB2UI is a robust automation platform powered by **Node.js**, **Express**, **NuxtJS**, and **PostgreSQL**. It comes Docker-ready with **pgAdmin** for database control and **Redis** support for caching, queuing, or session management.\n\n---\n\n## 🧰 Tech Stack\n\n| Layer         | Technology                            |\n|---------------|----------------------------------------|\n| **Frontend**  | NuxtJS 3 (Vue 3, Vite, SSR optional)   |\n| **Backend**   | Node.js, ExpressJS, TypeScript         |\n| **Database**  | PostgreSQL + pgAdmin GUI               |\n| **Cache**     | Redis                                  |\n| **Container** | Docker + Docker Compose                |\n\n---\n\n## 📦 Features\n\n- ✅ Modular API structure using Express + TypeScript\n- 🖥️ NuxtJS frontend with Vue 3 + Pinia support\n- 🐘 PostgreSQL with admin access via pgAdmin\n- 🔁 Redis-powered session/cache-ready setup\n- 🐳 Fully Dockerized: 1-command startup\n- 🔐 JWT Auth for secure endpoints\n- 🔌 Easy to extend with service-based jobs\n\n---\n\n## 🚀 Getting Started\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/Azshurith/DB2UI.git\ncd DB2UI\n```\n\n### 2. Create `.env` File\n\nCopy `.env.example` and configure ports, DB, JWT:\n\n```bash\ncp .env.example .env\n```\n\n### 3. Start with Docker\n\n```bash\ndocker-compose up -d\n```\n\nAccess:\n- Frontend: `http://localhost:4000`\n- Backend: `http://localhost:4001/api`\n- pgAdmin: `http://localhost:4002`\n- Redis: `localhost:6379`\n\n---\n\n## 🪟 Optional: Create Windows Symlink for WSL Projects\n\nTo access your WSL-based project directory easily from Windows (e.g. for editors like VSCode or file explorers), you can create a symbolic link:\n\n```powershell\n# Run PowerShell as Administrator\nNew-Item -ItemType SymbolicLink `\n  -Path \"D:\\Documents\\Projects\" `\n  -Target \"\\\\wsl.localhost\\Ubuntu-24.04\\home\\user\\Projects\"\n```\n\n### 🔎 Notes\n- Make sure the **target WSL path exists**.\n- This creates a Windows-accessible folder that mirrors your WSL project directory.\n- If you get a `NewItemIOError`, check if a folder already exists at the destination path.\n\n---\n\n## 🗂️ Project Structure\n\n```\nbackend/                 # Express + TypeScript backend\n  ├── src/\n  │   ├── routes/\n  │   ├── controllers/\n  │   └── config/\nfrontend/                # NuxtJS frontend (src/pages, src/components, etc.)\n.docker/                 # Dockerfiles for each service\n.env                     # Environment variables\ndocker-compose.yml       # Multi-container orchestrator\nMakefile                 # Project CLI with helper commands\n```\n\n---\n\n## 🛠️ Makefile CLI Commands\n\nUse `make help` to list all available commands:\n\n| Command            | Description                                  |\n|--------------------|----------------------------------------------|\n| `project_start`    | 🚀 Start all containers in detached mode     |\n| `project_stop`     | 🛑 Stop all running containers               |\n| `project_restart`  | 🔄 Restart all containers                    |\n| `project_destroy`  | 💣 Remove containers and volumes             |\n| `express_shell`    | 🔧 Open a shell in Express container         |\n| `express_install`  | 📦 Install backend dependencies              |\n| `express_update`   | 🔄 Update backend packages                   |\n| `express_dev`      | 🛠️ Run Express in dev mode                  |\n| `express_start`    | ▶️ Run Express in production mode            |\n| `express_build`    | 🔧 Build backend (if applicable)             |\n| `nuxt_shell`       | 🔧 Open a shell in Nuxt container            |\n| `nuxt_install`     | 📦 Install frontend dependencies             |\n| `nuxt_update`      | 🔄 Update frontend packages                  |\n| `nuxt_dev`         | 🛠️ Run Nuxt in dev mode                     |\n| `nuxt_start`       | ▶️ Run Nuxt in production mode              |\n| `nuxt_build`       | 🔧 Build frontend for production             |\n| `help`             | 📖 Show this help menu                       |\n\n---\n\n## 🔐 Authentication\n\nJWT-based auth is built-in. Use:\n\n```http\nAuthorization: Bearer \u003ctoken\u003e\n```\n\n---\n\n## 🧠 Redis Use Cases\n\n- Session \u0026 login state\n- API rate-limiting\n- Cache for scraped or job data\n\n---\n\n## 🛠️ Build Frontend Manually\n\n```bash\ncd frontend\nnpm install\nnpm run build\n```\n\n---\n\n## 👤 Author\n\n**Devitrax / Azshurith**  \nGitHub: [@Azshurith](https://github.com/Azshurith)\n\n---\n\n## 📄 License\n\n[MIT](./LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazshurith%2Fdb2ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazshurith%2Fdb2ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazshurith%2Fdb2ui/lists"}