mirror of
https://github.com/Permissionless-Software-Foundation/psf-memo-client.git
synced 2026-09-21 16:52:02 -07:00
Customizing README and package.json
This commit is contained in:
Chris Troutner
+1
-1
@@ -1,4 +1,4 @@
|
||||
Copyright 2022 Chris Troutner
|
||||
Copyright 2025 Chris Troutner
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
|
||||
@@ -1,39 +1,20 @@
|
||||
# react-bootstrap-web3-spa
|
||||
# bch-wallet-web3-spa
|
||||
|
||||
This is a single page app (SPA) based on [react-bootstrap](https://www.npmjs.com/package/react-bootstrap). This app is a template to show how to build a web app that leverages the [Cash Stack](https://cashstack.info) web3 architecture, a censorship-resistant back-end for accessing the Bitcoin Cash blockchain.
|
||||
This is a web-based single page app (SPA) written in React. It provides non-custodial wallet features for the Bitcoin Cash blockchain, including support for SLP tokens and NFTs.
|
||||
|
||||
This app can be compiled and uploaded to Filecoin via [web3.storage](https://web3.storage). This means a censorship-resistant front-end app (SPA) can be built, which communicates with a censorship-resistant back-end.
|
||||
The code repository is the successor to [bch-wallet-web-android](https://github.com/Permissionless-Software-Foundation/bch-wallet-web3-android). It is forked from [react-bootstrap-web3-spa](https://github.com/Permissionless-Software-Foundation/react-bootstrap-web3-spa), and any updates to that upstream repository are pulled into this repository. The individual wallet components from bch-wallet-web-android have been audited, refactored, and ported to this repository. It a complete rewrite of the original codebase.
|
||||
|
||||
- [Live Demo on GitHub Pages](https://permissionless-software-foundation.github.io/react-bootstrap-web3-spa/)
|
||||
- [Live Demo on Filecoin](https://bafybeic3nuawgogcfjkxxstyqyg6dmzajvkxp55ccldipwmgiyuikhrq5y.ipfs.dweb.link/)
|
||||
|
||||
## Major Features
|
||||
- [react-bootstrap](https://react-bootstrap.github.io/) is used for general style and layout control.
|
||||
- An easily customized *waiting modal* component can be invoked while waiting for network calls to complete.
|
||||
- [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is used to access tokens and BCH on the Bitcoin Cash blockchain.
|
||||
- A 'server selection' dropdown allows the user to select from an array of redundant [web3 back end servers](https://cashstack.info).
|
||||
- This site is statically compiled, uploaded to Filecoin, and served over IPFS for censorship resistance and version control.
|
||||
- A collapsible navigation menu is used to load different views.
|
||||
- This app can be compiled into an native Android app using [react-bootstrap-web3-android](https://github.com/Permissionless-Software-Foundation/react-bootstrap-web3-android).
|
||||
This code repository is intended to be a boilerplate for creating creative BCH-based web apps. It is built on top of the [Cash Stack](https://cashstack.info) web3 architecture, which provides a censorship-resistant back-end for accessing the Bitcoin Cash blockchain.
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
git clone https://github.com/Permissionless-Software-Foundation/react-bootstrap-web3-spa
|
||||
cd react-bootstrap-web3-spa
|
||||
git clone https://github.com/Permissionless-Software-Foundation/bch-wallet-web3-spa
|
||||
cd bch-wallet-web3-spa
|
||||
npm install
|
||||
npm start
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Publish to Filecoin
|
||||
```bash
|
||||
export FILECOIN_TOKEN=myFilecoinAPITokenFromWeb3.Storage
|
||||
npm run build
|
||||
npm run pub
|
||||
```
|
||||
|
||||
Learn more about alternative deployments in the [deployment directory](./deploy)
|
||||
|
||||
## Support
|
||||
|
||||
Have questions? Need help? Join our community support
|
||||
@@ -48,15 +29,5 @@ This open source software is developed and maintained by the [Permissionless Sof
|
||||
<p>bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr</p>
|
||||
</div>
|
||||
|
||||
## Repo Backup
|
||||
This GitHub repository is backed up on [Radicle](https://radicle.network/get-started.html). If GitHub ever censors this respository, the code can be found in this alternative repository. [Here are extra notes on working with Radicle](https://christroutner.github.io/trouts-blog/docs/censorship/radicle).
|
||||
|
||||
- Project ID: rad:git:hnrkd5cjwwb5tzx37hq9uqm5ubon7ee468xcy
|
||||
- [Repo on Rad Website](https://app.radicle.network/seeds/maple.radicle.garden/rad:git:hnrkd5cjwwb5tzx37hq9uqm5ubon7ee468xcy/remotes/hyyycncbn9qzqmobnhjq9rry6t4mbjiadzjoyhaknzxjcz3cxkpfpc)
|
||||
|
||||
This can be cloned from [PSF](https://psfoundation.info) Radicle seed node with one of these commands:
|
||||
- `rad clone rad:git:hnrkd5cjwwb5tzx37hq9uqm5ubon7ee468xcy --seed radicle.fullstackcash.nl`
|
||||
- `rad clone rad:git:hnrkd5cjwwb5tzx37hq9uqm5ubon7ee468xcy --seed maple.radicle.garden`
|
||||
|
||||
## License
|
||||
[MIT](./LICENSE.md)
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "react-bootstrap-web3-spa",
|
||||
"version": "2.0.1",
|
||||
"name": "bch-wallet-web3-spa",
|
||||
"version": "1.0.0",
|
||||
"dependencies": {
|
||||
"axios": "0.27.2",
|
||||
"bch-message-lib": "2.2.1",
|
||||
|
||||
Reference in New Issue
Block a user