Get started using BUX in five minutes
- What is BUX?
- Environment Variables
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Contributing
- License
| Variable name | Description |
|---|---|
| BUX_ENVIRONMENT | development or production |
| BUX_AUTHENTICATION**ADMIN_KEY | [your-admin-xpriv] |
| BUX_AUTHENTICATION**REQUIRE_SIGNING | 1 or 0 |
| BUX_DATASTORE**ENGINE | mongodb, sqlite, mysql |
| BUX_MONGODB**URI | mongodb://localhost:27017/bux |
| BUX_MONGODB**DATABASE_NAME | bux |
| BUX_DATASTORE**AUTO_MIGRATE | 1 or 0 |
| BUX_CACHE**ENGINE | freecache or redis |
| BUX_REDIS**URL | redis://localhost:6379 |
| BUX_MONITOR**ENABLED | 1 or 0 |
| BUX_GRAPHQL**ENABLED | 1 or 0 |
| BUX_DEBUG | 1 or 0 |
| BUX_NEW_RELIC**ENABLED | 1 or 0 |
| BUX_NEW_RELIC**ENABLED | 1 or 0 |
| BUX_NEW_RELIC**DOMAIN_NAME | bux-nyc1.bux.ninja |
| BUX_NEW_RELIC**LICENSE_KEY | [your-key] |
bux-server requires a supported release of Go.
go get -u github.com/BuxOrg/bux-servergo build -o bux-server cmd/server/*./bux-serverView the generated documentation
Repository Features
This repository was created using MrZ's go-template
- Continuous integration via GitHub Actions
- Build automation via Make
- Dependency management using Go Modules
- Code formatting using gofumpt and linting with golangci-lint and yamllint
- Unit testing with testify, race detector, code coverage HTML report and Codecov report
- Releasing using GoReleaser on new Tag
- Dependency scanning and updating thanks to Dependabot and Nancy
- Security code analysis using CodeQL Action
- Automatic syndication to pkg.go.dev on every release
- Generic templates for Issues and Pull Requests in Github
- All standard Github files such as
LICENSE,CONTRIBUTING.md,CODE_OF_CONDUCT.md, andSECURITY.md - Code ownership configuration for Github
- All your ignore files for vs-code, docker and git
- Automatic sync for labels into Github using a pre-defined configuration
- Built-in powerful merging rules using Mergify
- Welcome new contributors on their first Pull-Request
- Follows the standard-readme specification
- Visual Studio Code configuration with Go
- (Optional) Slack, Discord or Twitter announcements on new Github Releases
- (Optional) Easily add contributors in any Issue or Pull-Request
Package Dependencies
Library Deployment
Releases are automatically created when you create a new git tag!
If you want to manually make releases, please install GoReleaser:
goreleaser for easy binary or library deployment to Github and can be installed:
- using make:
make install-releaser - using brew:
brew install goreleaser
The .goreleaser.yml file is used to configure goreleaser.
Automatic releases via Github Actions from creating a new tag:
make tag version=1.2.3Use make release-snap to create a snapshot version of the release, and finally make release to ship to production (manually).
Makefile Commands
View all makefile commands
make helpList of all current commands:
all Runs multiple commands
clean Remove previous builds and any cached data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
diff Show the git diff
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
graphql Generates the graphql schemas
help Show this help message
install Install the application
install-all-contributors Installs all contributors locally
install-go Install the application (Using Native Go)
install-releaser Install the GoReleaser application
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs coverage
uninstall Uninstall the application (and remove files)
update-contributors Regenerates the contributors html/list
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
All unit tests and examples run via Github Actions and uses Go version 1.18.x. View the configuration file.
Run all tests (including integration tests)
make testRun tests (excluding integration tests)
make test-shortRun the Go benchmarks:
make benchRead more about this Go project's code standards.
Checkout all the examples!
To get started with development, bux-server provides a docker-compose.yml
file which starts up Bux Server with Redis and PostgreSQL. To start, we need to
tweak the config/envs/development.json file with the proper configuration.
First:
$ cp config/envs/docker-compose.json config/envs/development.json
Then, we need to update the admin_key with your xpub. Modify
config/envs/development.json with your admin key. Now we can start the
containers:
$ docker-compose up
View the contributing guidelines and follow the code of conduct.
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀
Thank you to these wonderful people (emoji key):
 Mr. Z 🚇 💻 🚧 🛡️ |
 Siggi 🚇 💻 🛡️ |
 Dylan 🚇 💻 |
This project follows the all-contributors specification.
