Readme & License

Dockerfile

@@ -3,38 +3,29 @@ FROM node:20-alpine AS builder
 
 WORKDIR /app
 
-# Zuerst package.json und package-lock.json kopieren
 COPY package.json package-lock.json* ./
 
-# Prisma-Verzeichnis kopieren (mit explizitem Pfad-Check)
 COPY ./prisma ./prisma
 
-# Abhängigkeiten installieren
 RUN npm install
 RUN npx prisma generate
 
-# Restlichen Code kopieren
 COPY . .
 
-# Build durchführen
 RUN npm run build
 
-# Production Stage
 FROM node:20-alpine AS production
 
 WORKDIR /app
 
 ENV NODE_ENV production
 
-# Nur Produktionsabhängigkeiten installieren
 COPY package.json package-lock.json* ./
 RUN npm install --production
 
-# Prisma-Client kopieren
 COPY --from=builder /app/node_modules/.prisma /app/node_modules/.prisma
 COPY --from=builder /app/node_modules/@prisma /app/node_modules/@prisma
 
-# Next.js Build-Artefakte
 COPY --from=builder /app/.next ./.next
 COPY --from=builder /app/public ./public
 COPY --from=builder /app/package.json ./package.json

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Damian Bergemann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,36 +1,76 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
 
-## Getting Started
+![Logo](https://i.ibb.co/hwSZTJH/Kopie-von-Cash-Mate.png)
 
-First, run the development server:
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+# Dashdict
+
+The only dashboard you'll ever need to manage your entire server infrastructure. Keep all your server data organized in one central place, easily add your self-hosted applications with quick access links, and monitor their availability in real-time with built-in uptime tracking. Designed for simplicity and control, it gives you a clear overview of your entire self-hosted setup at a glance.
+
+## Features
+
+- Dashboard: A clear screen with all the important information about your servers (WIP)
+- Servers: This allows you to add all your servers (including Hardware Information), with Quicklinks to their Management Panels
+- Applications: Add all your self-hosted services to a clear list and track their up and down time
+- Networks: Generate visually stunning network flowcharts with ease.
+
+## Roadmap
+- [] Edit Applications, Applications searchbar
+- [] Customizable Dashboard
+- [] Notifications
+- [] Uptime History
+- [] Simple Server Monitoring
+- [] Improved Network Flowchart with custom elements (like Network switches)
+- [] Advanced Settings (Disable Uptime Tracking & more)
+
+## Deployment
+
+Simply run this compose.yml:
+```yml
+services:
+  web:
+    image: haedlessdev/corecontrol:latest
+    ports:
+      - "3000:3000"
+    environment:
+      LOGIN_EMAIL: "mail@example.com"
+      LOGIN_PASSWORD: "SecretPassword"
+      JWT_SECRET: RANDOM_SECRET
+      ACCOUNT_SECRET: RANDOM_SECRET
+      DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres?sslmode=require&schema=public"
+    depends_on:
+      - db
+      - agent
+
+  agent:
+    image: haedlessdev/corecontrol-agent:latest
+    environment:
+      DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres?sslmode=require&schema=public"
+
+  db:
+    image: postgres:17
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Tech Stack & Credits
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+The application is build with:
+- Next.js & Typescript
+- Go (for the agent)
+- Tailwindcss with [shadcn](shadcn.com)
+- PostgreSQL with [Prisma ORM](https://www.prisma.io/)
+- Icons by [Lucide](https://lucide.dev/)
+- Flowcharts by [React Flow](https://reactflow.dev/)
+- and a lot of love ❤️
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+## License
 
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Licensed under the [MIT License](https://github.com/crocofied/CoreControl/blob/main/LICENSE).