BUX: Console

Administrative dashboard to manage your BUX Server

Table of Contents

• What is BUX?
• Installation
• Documentation
• Code Standards
• Usage
• Contributing
• License

What is BUX?

Read more about BUX

Installation

npm install -g yarn
yarn install

Running

yarn start

Running from Docker-Compose

1. If you want to change default environment variables - create a file env-config.json somewhere in your filesystem and override the variables that you want to change. No all variables need to be overriden. For example:

{
  "serverUrl": "http://localhost:3003/v1"
}

2. Mount this file from your filesystem to config.json in docker-compose:

services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - '3000:3000'
    volumes:
      - '/host/path/to/env-config.json:/usr/share/nginx/html/env-config.json'

3. Run docker-compose

docker-compose up -d

Documentation

View more BUX documentation

Release Deployment

goreleaser for easy binary or library deployment to GitHub and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

audit                         Checks for any packages that are vulnerable
clean                         Remove previous builds and any test cache data
help                          Show this help message
install                       Install the application
install-all-contributors      Installs all contributors locally
outdated                      Checks for any outdated packages
release                       Full production release (creates release in GitHub)
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)
start                         Starts the console
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)
update-contributors           Regenerates the contributors html/list

Code Standards

Please read our standards document

Usage

Here's the getting started with BUX

Contributing

View the contributing guidelines and follow the code of conduct.

How can I help?

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! 🚀

Contributors ✨

Thank you to these wonderful people (emoji key):

Siggi 🚇 💻 🛡️

Mr. Z 🚇 💻 🚧 💼

Dylan 💻

This project follows the all-contributors specification.

License