Mozart409/pulumi-pve-homelab

Pulumi PVE homelab

► My personal pulumi project for creating lxc containers

Table of Contents

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

► INSERT-TEXT-HERE

---

Features

► INSERT-TEXT-HERE

---

Repository Structure

└── pulumi-pve-homelab/
    ├── LICENSE
    ├── Pulumi.yaml
    ├── README.md
    ├── biome.jsonc
    ├── index.ts
    ├── justfile
    ├── lefthook.yml
    ├── package.json
    ├── pnpm-lock.yaml
    └── tsconfig.json

---

Modules

.

File	Summary
pnpm-lock.yaml	► INSERT-TEXT-HERE
lefthook.yml	► INSERT-TEXT-HERE
Pulumi.yaml	► INSERT-TEXT-HERE
justfile	► INSERT-TEXT-HERE
tsconfig.json	► INSERT-TEXT-HERE
index.ts	► INSERT-TEXT-HERE
biome.jsonc	► INSERT-TEXT-HERE
package.json	► INSERT-TEXT-HERE

---

Getting Started

System Requirements:

• Just: version 1.25
• Pulumi: version 3.122

Installation

From source

1. Clone the pulumi-pve-homelab repository:

$ git clone https://github.com/mozart409/pulumi-pve-homelab

2. Change to the project directory:

$ cd pulumi-pve-homelab

3. Install the dependencies:

$ pnpm install

4. Set environment variables:

$ cp .env.example .env

Usage

From source

Run pulumi-pve-homelab using the command below:

$ just up

Tests

Run the test suite using the command below:

$ > INSERT-TEST-COMMANDS

---

Project Roadmap

• ► INSERT-TASK-1
• ► INSERT-TASK-2
• ► ...

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the pulumi-pve-homelab project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/mozart409/pulumi-pve-homelab

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

---

Acknowledgments

• List any resources, contributors, inspiration, etc. here.

Return

---