Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitcoin-sv/spv-wallet-admin

Administrative console for interacting with spv-wallet servers
https://github.com/bitcoin-sv/spv-wallet-admin

admin bsv bux spv-wallet spv-wallet-team spv-wallet-toolkit utxo

Last synced: 2 months ago
JSON representation

Administrative console for interacting with spv-wallet servers

Awesome Lists containing this project

README

        

# SPV-WALLET-ADMIN

## Table of Contents
- [What is SPV-Wallet?](#what-is-spv-wallet)
- [Installation](#installation)
- [Documentation](#documentation)
- [Code Standards](#code-standards)
- [Running](#running)
- [Contributing](#contributing)
- [License](#license)


## What is SPV-Wallet?
[Read more about SPV-Wallet](https://github.com/bitcoin-sv/spv-wallet/blob/main/README.md)

For in-depth information and guidance, please refer to the [SPV Wallet Documentation](https://docs.bsvblockchain.org/network-topology/applications/spv-wallet).


## Installation
```shell
npm install -g yarn
yarn install
```

## Running
```shell
yarn start
```

## Documentation

Release Deployment

[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to GitHub and can be installed via: `brew install goreleaser`.

The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/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
```shell script
make help
```

List of all current commands:
```text
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](.github/CODE_STANDARDS.md)


## Contributing
View the [contributing guidelines](.github/CODE_STANDARDS.md#3-contributing) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).


## Contributing
All kinds of contributions are welcome!


To get started, take a look at [code standards](.github/CODE_STANDARDS.md).


View the [contributing guidelines](.github/CODE_STANDARDS.md#3-contributing) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).


## License
[![License](https://img.shields.io/github/license/bitcoin-sv/spv-wallet-admin.svg?style=flat&v=1)](LICENSE)