Self-hosted, plugin-based server management.
TypeScript dockerhomelabpluginsrdpremote-desktopself-hostedserver-managementsftpsshterminaltermixvnc
Update CONTRIBUTING.md
Karmaa0f75cd4d16c7
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex c70c8baaa..f80b65b20 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,3 +1,5 @@+# Contributing+## Prerequisites- [Node.js](https://nodejs.org/en/download/) (built with v24)@@ -7,13 +9,13 @@## Installation1. Clone the repository:- ```sh- git clone https://github.com/LukeGus/Termix- ```+ ```sh+ git clone https://github.com/LukeGus/Termix+ ```2. Install the dependencies:- ```sh- npm install- ```+ ```sh+ npm install+ ```## Running the development server@@ -24,7 +26,6 @@ npm run devnpm run dev:backend```-aThis will start the backend and the frontend Vite server. You can access Termix by going to `http://localhost:5174/`.## Contributing@@ -32,21 +33,21 @@ This will start the backend and the frontend Vite server. You can access Termix1. **Fork the repository**: Click the "Fork" button at the top right ofthe [repository page](https://github.com/LukeGus/Termix).2. **Create a new branch**:- ```sh- git checkout -b feature/my-new-feature- ```+ ```sh+ git checkout -b feature/my-new-feature+ ```3. **Make your changes**: Implement your feature, fix, or improvement.4. **Commit your changes**:- ```sh- git commit -m "Feature request my new feature"- ```+ ```sh+ git commit -m "Feature request my new feature"+ ```5. **Push to your fork**:- ```sh- git push origin feature/my-feature-request- ```+ ```sh+ git push origin feature/my-feature-request+ ```6. **Open a pull request**: Go to the original repository and create a PR with a clear description.-## 📝 Guidelines+## Guidelines- Follow the existing code style. Use Tailwind CSS with shadcn components.- Use the below color scheme with the respective CSS variable placed in the `className` of a div/component.@@ -60,7 +61,7 @@ This will start the backend and the frontend Vite server. You can access Termix### Background Colors| CSS Variable | Color Value | Usage | Description |-| ----------------------------- | ----------- | --------------------------- | ---------------------------------------- |+|-------------------------------|-------------|-----------------------------|------------------------------------------|| `--color-dark-bg` | `#18181b` | Main dark background | Primary dark background color || `--color-dark-bg-darker` | `#0e0e10` | Darker backgrounds | Darker variant for panels and containers || `--color-dark-bg-darkest` | `#09090b` | Darkest backgrounds | Darkest background (terminal) |@@ -72,7 +73,7 @@ This will start the backend and the frontend Vite server. You can access Termix### Element-Specific Backgrounds| CSS Variable | Color Value | Usage | Description |-| ------------------------ | ----------- | ------------------ | --------------------------------------------- |+|--------------------------|-------------|--------------------|-----------------------------------------------|| `--color-dark-bg-input` | `#222225` | Input fields | Background for input fields and form elements || `--color-dark-bg-button` | `#23232a` | Button backgrounds | Background for buttons and clickable elements || `--color-dark-bg-active` | `#1d1d1f` | Active states | Background for active/selected elements |@@ -81,7 +82,7 @@ This will start the backend and the frontend Vite server. You can access Termix### Border Colors| CSS Variable | Color Value | Usage | Description |-| ---------------------------- | ----------- | --------------- | ---------------------------------------- |+|------------------------------|-------------|-----------------|------------------------------------------|| `--color-dark-border` | `#303032` | Default borders | Standard border color || `--color-dark-border-active` | `#2d2d30` | Active borders | Border color for active elements || `--color-dark-border-hover` | `#434345` | Hover borders | Border color on hover states |@@ -92,7 +93,7 @@ This will start the backend and the frontend Vite server. You can access Termix### Interactive States| CSS Variable | Color Value | Usage | Description |-| ------------------------ | ----------- | ----------------- | --------------------------------------------- |+|--------------------------|-------------|-------------------|-----------------------------------------------|| `--color-dark-hover` | `#2d2d30` | Hover states | Background color for hover effects || `--color-dark-active` | `#2a2a2c` | Active states | Background color for active elements || `--color-dark-pressed` | `#1a1a1c` | Pressed states | Background color for pressed/clicked elements |