format & add server-modules

Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com>

Former-commit-id: ea0d931b6464252a90f71953bf774d574b15a2d0
This commit is contained in:
Hadi
2025-06-26 00:13:57 +02:00
parent b241a2f367
commit 1c539f857d

View File

@@ -1,5 +1,5 @@
<div align="center"> <div align="center">
<img src="https://raw.githubusercontent.com/anotherhadi/nixy/main/.github/assets/logo.png" width="120px" /> <img alt="nixy logo" src="https://raw.githubusercontent.com/anotherhadi/nixy/main/.github/assets/logo.png" width="120px" />
</div> </div>
<br> <br>
@@ -23,14 +23,17 @@
</div> </div>
<br> <br>
**Nixy simplifies and unifies** the Hyprland ecosystem with a modular, easily customizable setup. It provides a structured way to manage your system configuration and dotfiles with minimal effort. **Nixy simplifies and unifies** the Hyprland ecosystem with a modular, easily
It includes *home-manager*, *secrets*, and *custom theming* all in one place. customizable setup. It provides a structured way to manage your system
configuration and dotfiles with minimal effort. It includes _home-manager_,
_secrets_, and _custom theming_ all in one place.
**Features:** **Features:**
- 💻 Hyprland-centric: Preconfigured Hyprland ecosystem (Hyprlock, Hyprpanel, etc.) - 💻 Hyprland-centric: Preconfigured Hyprland ecosystem (Hyprlock, Hyprpanel,
etc.)
- 🎨 Consistent Theming: Base16 & Stylix-powered themes - 🎨 Consistent Theming: Base16 & Stylix-powered themes
- ⌨️ Vim-like Everywhere: Unified keybindings (Hyprland, nvim, vimium, etc.) - ⌨️ Vim-like Everywhere: Unified keybindings (Hyprland, nvim, vimium, etc.)
## Table of Content ## Table of Content
@@ -57,45 +60,54 @@ Contains **dotfiles and settings** that apply to your user environment.
### 🐧 /nixos ### 🐧 /nixos
Those are the system-level configurations. (audio, bluetooth, gpu, bootloader, ...) Those are the system-level configurations. (audio, bluetooth, gpu, bootloader,
...)
### 🎨 /themes ### 🎨 /themes
This folder contains all system themes. Mainly [stylix](https://stylix.danth.me/) configurations. This folder contains all system themes. Mainly
Check out the available themes and learn how to create your own in [THEMES.md](docs/THEMES.md) [stylix](https://stylix.danth.me/) configurations. Check out the available
themes and learn how to create your own in [THEMES.md](docs/THEMES.md)
### 💻 /hosts ### 💻 /hosts
This directory contains host-specific configurations. This directory contains host-specific configurations. Each host includes:
Each host includes:
- `configuration.nix` for system-wide settings - `configuration.nix` for system-wide settings
- `home.nix` for user-level configuration - `home.nix` for user-level configuration
- `variables.nix` for global variables - `variables.nix` for global variables
- `secrets/` for sensitive data - `secrets/` for sensitive data
### 🖥️ /server-modules
This folder contains server-related nixos modules. (bitwarden, nextcloud, ...)
## Installation ## Installation
1. [Fork](https://github.com/anotherhadi/nixy/fork) this repo and clone it to your system: 1. [Fork](https://github.com/anotherhadi/nixy/fork) this repo and clone it to
your system:
```sh ```sh
git clone https://github.com/anotherhadi/nixy ~/.config/nixos git clone https://github.com/anotherhadi/nixy ~/.config/nixos
``` ```
2. Copy the `hosts/laptop` folder, rename it to match your systems hostname, and update `variables.nix` with your machines settings. 2. Copy the `hosts/laptop` folder, rename it to match your systems hostname,
3. Copy your `hardware-configuration.nix` into your new host's folder to ensure proper hardware support. and update `variables.nix` with your machines settings.
3. Copy your `hardware-configuration.nix` into your new host's folder to ensure
proper hardware support.
4. Register your new host in `flake.nix` by adding it under nixosConfigurations. 4. Register your new host in `flake.nix` by adding it under nixosConfigurations.
> [!Important] > [!Important] `# CHANGEME` comments are placed throughout the config to
> `# CHANGEME` comments are placed throughout the config to indicate necessary modifications. > indicate necessary modifications. Use the following command to quickly locate
> Use the following command to quickly locate them: > them:
> >
> ```sh > ```sh
> rg "CHANGEME" ~/.config/nixos > rg "CHANGEME" ~/.config/nixos
> ``` > ```
> [!TIP] > [!TIP]
> When you add new files, don't forget to run `git add .` to add them to the git repository > When you add new files, don't forget to run `git add .` to add them to the git
> repository
5. Build the system 5. Build the system
@@ -108,8 +120,10 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname
- [SERVER](docs/SERVER.md): Check out the server documentation - [SERVER](docs/SERVER.md): Check out the server documentation
- [THEMES](docs/THEMES.md): How themes work and how to create your own - [THEMES](docs/THEMES.md): How themes work and how to create your own
- [SCRIPTS](docs/SCRIPTS.md): A list of available scripts and their usage - [SCRIPTS](docs/SCRIPTS.md): A list of available scripts and their usage
- [KEYBINDINGS-HYPRLAND](docs/KEYBINDINGS-HYPRLAND.md): Keybindings available in Hyprland - [KEYBINDINGS-HYPRLAND](docs/KEYBINDINGS-HYPRLAND.md): Keybindings available in
- [WALLPAPERS](https://github.com/anotherhadi/awesome-wallpapers): An awesome collection of wallpapers Hyprland
- [WALLPAPERS](https://github.com/anotherhadi/awesome-wallpapers): An awesome
collection of wallpapers
- [CONTRIBUTING](docs/CONTRIBUTING.md): How to contribute - [CONTRIBUTING](docs/CONTRIBUTING.md): How to contribute
- [LICENSE](LICENSE): MIT License - [LICENSE](LICENSE): MIT License