launchrail

module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2025 License: GPL-3.0

README ΒΆ

Launchrail

Build and Test Lint and Vet Quality Gate Status Coverage Benchmark CodeQL Dependabot Updates Go Reference

Launchrail is an open-source 6DOF High-Powered Rocket Simulator. It leverages OpenRocket design files for configuration and ThrustCurve API for motor curves. The project also explores using financial algorithms to model atmospheric turbulence.

Index PageData PageExplore Motion PageExplore Plot Page

πŸš€ Getting Started

git clone https://github.com/bxrne/launchrail.git
cd launchrail

go run ./cmd/launchrail
# For hot reload (development)
air

🐳 Docker Usage

You can run Launchrail as a Docker container, either by building locally or pulling from GHCR.

Build and Run Locally
DOCKER_BUILDKIT=1 docker build -t launchrail:latest .
docker run --rm -it -p 8080:8080 launchrail:latest
Pull and Run from GHCR
docker pull ghcr.io/bxrne/launchrail:latest
# Or pull a specific version
docker pull ghcr.io/bxrne/launchrail:<tag>
docker run --rm -it -p 8080:8080 ghcr.io/bxrne/launchrail:latest

πŸ§‘β€πŸ’» Contributing & Git Workflow

We welcome contributions! See CONTRIBUTING.md for full guidelines.

  • Clone and branch:
    git clone https://github.com/bxrne/launchrail.git
    git checkout -b my-feature-branch
    
  • Run tests:
    go test ./... -v
    
  • Lint:
    golangci-lint run ./...
    
  • Commit using Commitizen:
    cz commit
    
    This project uses Commitizen and Conventional Commits for semantic versioning (see .cz.toml). Semantic versioning is enforced for all releases and PRs. Please use cz commit to ensure proper versioning and changelogs.

πŸ§ͺ Testing

Run all tests:

go test ./... -v

πŸ› οΈ Built With

  • Go β€” The Go Programming Language
  • OpenRocket β€” Model rocket design and simulation
  • ThrustCurve β€” Model rocket motor database

πŸ“¦ License

This project is licensed under the GNU General Public License v3.0 β€” see the LICENSE file for details.

Directories ΒΆ

Path Synopsis
cmd
benchmark command
launchrail command
server command
internal
pkg
plugins
blackscholes command
windeffect command
templates
components
templ: version: v0.3.865
templ: version: v0.3.865
layouts
templ: version: v0.3.865
templ: version: v0.3.865
pages
templ: version: v0.3.865
templ: version: v0.3.865

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL