my-project

A BleuMoon project.

Prerequisites

• BleuMoon v2.0.0 or later
• StyLua (for code formatting)

Tip: If you have Nix with flakes enabled, both tools are provided automatically via nix develop.

Getting Started

With Nix (recommended)

git clone https://git.ds.reinitialized.net/your-org/my-project.git
cd my-project
nix develop

This drops you into a shell with BleuMoon, Luau LSP, and StyLua available.

Without Nix

1. Install BleuMoon and StyLua manually.
2. Clone the repository:

   git clone https://git.ds.reinitialized.net/your-org/my-project.git
   cd my-project
   

3. Install dependencies:

   bleumoon pkg install
   

4. Run the application:

   bleumoon run src/main
   

Running Tests

bleumoon run tests/init

Formatting

Check formatting:

stylua --check .

Apply formatting:

stylua .

Project Structure

├── .editorconfig          # Editor configuration
├── .forgejo/workflows/    # CI/CD pipelines (Forgejo Actions)
├── .github/               # GitHub/Copilot configuration
├── .luaurc                # Luau language settings & aliases
├── .vscode/               # VS Code workspace settings
├── bleumoon.toml          # Project manifest & dependencies
├── flake.nix              # Nix flake for reproducible dev environment
├── scripts/               # Helper scripts (LSP wrapper, etc.)
├── stylua.toml            # StyLua formatter configuration
├── CHANGELOG.md           # Version history
├── LICENSE                # MIT License
├── README.md              # This file
├── docs/
│   ├── architecture/      # Architecture Decision Records
│   └── investigations/    # Bug investigation write-ups
├── src/
│   └── main.luau          # Application entry point
├── tests/
│   └── init.luau          # Test runner & test cases
├── packages/              # Installed dependencies (auto-managed, gitignored)
└── types/                 # Auto-generated type definitions (gitignored)

License

This project is licensed under the MIT License.