NixOS Configuration System

🚀 A Modern, Customizable NixOS Configuration

A powerful, modular, and reproducible NixOS configuration system designed for modern computing needs.

Key Features • Installation • Configuration • Customization • Documentation • Contributing

📋 Overview

This NixOS configuration system leverages the power of Nix Flakes to create a fully reproducible and declarative system setup. Whether you're a developer, content creator, or power user, this configuration provides a solid foundation that can be easily customized to meet your specific needs.

Why This Configuration?

• 🔄 Reproducible: Every aspect of your system can be recreated exactly as intended
• 🛠 Modular: Easily enable or disable components based on your needs
• 📦 Declarative: Your entire system configuration is defined in code
• 🔒 Secure: Security-focused defaults and easy-to-audit configurations
• 🎨 Customizable: Extensive theming and personalization options
• 🚀 Performance: Optimized system configurations for maximum efficiency

✨ Key Features

Core Components

• 🔄 Nix Flakes - Next-generation reproducible package management
• 🏠 Home Manager - Sophisticated user environment management
• 🎨 Desktop Environments - Multiple pre-configured options:
  • Hyprland
  • GNOME
  • i3
  • Custom WM setups

🚀 Installation

Prerequisites

Before you begin, ensure you have:

• A NixOS installation or live environment
• Internet connection
• Basic understanding of Nix/NixOS concepts
• At least 50GB of free disk space
• 8GB RAM (16GB recommended)

Quick Start

1. Clone the Repository

   git clone https://github.com/sijanthapa171/NixOS.git
   cd NixOS

2. Review Configuration

   # Edit flake.nix to set your preferences
   nvim flake.nix

3. Installation Options

   For existing NixOS systems:

   ./install.sh

   For fresh installations:

   ./live-install.sh

4. Post-Installation

   # Rebuild and switch to the new configuration
   nixos-rebuild switch --flake .#Default

⚙️ Configuration

Core Settings (flake.nix)

settings = {
  username = "your-username";
  editor = "nixvim";    # Options: nixvim, vscode, nvchad, neovim
  browser = "floorp";   # Options: firefox, floorp, zen
  terminal = "kitty";   # Options: kitty, alacritty, wezterm
  videoDriver = "nvidia"; # Options: nvidia, amdgpu, intel
};

Available Configurations

Category	Options	Description
Editors	nixvim, vscode, nvchad	Pre-configured editor setups
Browsers	firefox, floorp, zen	Browser configurations with privacy focus
Terminals	kitty, alacritty, wezterm	Modern terminal emulators
File Managers	yazi, lf	Terminal and GUI file managers
Themes	astronaut, black_hole, purple_leaves	SDDM and system themes

📁 Project Structure

NixOS/
├── modules/           # Core system modules
│   ├── desktop/      # Desktop environments
│   ├── hardware/     # Hardware configurations
│   ├── programs/     # Application setups
│   ├── scripts/      # Utility scripts
│   └── themes/       # Visual customizations
├── hosts/            # Host-specific configs
├── pkgs/            # Custom packages
├── overlays/        # Nixpkgs overlays
└── dev-shells/      # Development environments

🔧 Customization

Adding New Programs

1. Create a new module in modules/programs/:

   # modules/programs/your-program/default.nix
   { config, lib, pkgs, ... }:
   {
     config = {
       # Your configuration here
     };
   }

2. Import your module in the main configuration.

Theme Customization

1. Choose a pre-configured theme:

   sddmTheme = "purple_leaves";

2. Or create your own in modules/themes/.

Hardware Configuration

Adjust hosts/Default/hardware-configuration.nix for your specific hardware needs.

📚 Documentation

• Configuration Guide
• Customization Guide
• Troubleshooting
• FAQ

🤝 Contributing

We welcome contributions! Here's how you can help:

1. 🍴 Fork the repository
2. 🌿 Create a feature branch
3. 💻 Make your changes
4. 🔍 Test your changes
5. 📝 Create a Pull Request

Please read our Contributing Guidelines for more details.

🙏 Acknowledgments

• NixOS Community
• Home Manager Project
• All our amazing contributors

⚠️ Notes

• Regular updates are released - check the changelog
• Report bugs through GitHub Issues
• Join our Discord Community for support

🔄 Update Policy

• Major updates: Every 6 months
• Security updates: As needed
• Bug fixes: Weekly/Bi-weekly

---

Made with ❤️ by the NixOS community

Website • Forum • Matrix