bangbang

command module
v0.1.2 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2024 License: MIT Imports: 10 Imported by: 0

README ΒΆ

πŸ’₯ BangBang

Go Report Card Go Reference

BangBang is a lightweight, portable Kanban board that lives in your project directory. It uses a single markdown file (.bangbang.md) to store your board's data, making it perfect for version control and easy sharing with your team.

Example Project

✨ Features

  • πŸš€ Instant Setup: Just run bangbang in any directory to create a new board
  • πŸ“ Directory-Specific Boards: Each directory can have its own .bangbang.md board
  • 🎯 Markdown-Based: All data stored in a simple, version-control friendly format
  • πŸ–₯️ Modern Web UI: Drag-and-drop interface with mobile support
  • 🎨 Responsive Design: Works seamlessly on desktop and mobile devices
  • πŸ”„ Real-time Updates: Changes are instantly saved to the markdown file
  • 🌐 Local Server: Runs on localhost, no external dependencies needed

πŸš€ Quick Start

Install bangbang using the install script (recommended):

curl -fsSL https://raw.githubusercontent.com/1broseidon/bangbang/main/scripts/install.sh | bash

Or using Go (requires Go 1.23.4 or later):

go install github.com/1broseidon/bangbang@latest

Run it:

# Run in any directory
bangbang

# Or specify a custom directory and port
bangbang -d /path/to/project -p 8080

πŸ’‘ Usage

  1. Navigate to your project directory
  2. Run bangbang
  3. Open http://localhost:9000 in your browser
  4. Start organizing your tasks!

The board data is stored in .bangbang.md in your current directory. This file can be committed to version control, allowing you to track changes and share the board with your team.

πŸ› οΈ Development

# Clone the repository
git clone https://github.com/1broseidon/bangbang.git

# Install dependencies
go mod download

# Run the server
go run main.go

🎯 Why BangBang?

  • Simple: No databases, no cloud storage, just a markdown file
  • Portable: Run it anywhere Go is installed
  • Version Control Friendly: Track board changes in git
  • Team Friendly: Share boards via your existing version control
  • Offline First: Everything runs locally
  • Privacy Focused: Your data never leaves your machine

πŸ“ License

MIT License - see the LICENSE file for details

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
internal
api

Jump to

Keyboard shortcuts

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