Changeset View
Changeset View
Standalone View
Standalone View
web/cashtab/README.md
# CashTab | # CashTab | ||||
## Bitcoin Cash Web Wallet | ## Bitcoin Cash Web Wallet | ||||
### Features | ### Features | ||||
- Send & Receive BCH | - Send & Receive BCH | ||||
- Import existing wallets | - Import existing wallets | ||||
## Development | ## Development | ||||
CashTab relies on some modules that retain legacy dependencies. NPM version 7 or later no longer supports automatic resolution of these peer dependencies. To successfully install modules such as `qrcode.react`, with NPM > 7, run `npm install` with the flag `--legacy-peer-deps` | |||||
``` | ``` | ||||
npm install --legacy-peer-deps | npm install | ||||
npm start | npm start | ||||
``` | ``` | ||||
Runs the app in the development mode.<br> | Runs the app in the development mode.<br> | ||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||||
The page will reload if you make edits.<br> | The page will reload if you make edits.<br> | ||||
You will also see any lint errors in the console. | You will also see any lint errors in the console. | ||||
## Testing | ## Testing | ||||
### 'npm test' | Run the tests in watch mode (interactive): | ||||
``` | |||||
npm test | |||||
``` | |||||
### 'npm run test:coverage' | Run the tests and generate a coverage report (non-interactive): | ||||
``` | |||||
npm run test:coverage | |||||
``` | |||||
You can then browse the HTML coverage report by opening the | |||||
`coverage/lcov-report/index.html` file in your web browser. | |||||
## Production | ## Production | ||||
In the project directory, run: | In the project directory, run: | ||||
### `npm run build` | ``` | ||||
npm run build | |||||
``` | |||||
Builds the app for production to the `build` folder.<br> | Builds the app for production to the `build` folder.<br> | ||||
It correctly bundles React in production mode and optimizes the build for the best performance. | It correctly bundles React in production mode and optimizes the build for the best performance. | ||||
The build is minified and the filenames include the hashes.<br> | The build is minified and the filenames include the hashes.<br> | ||||
Your app is ready to be deployed! | Your app is ready to be deployed! | ||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||||
## Browser Extension | ## Browser Extension | ||||
1. `npm run extension` | 1. `npm run extension` | ||||
2. Open Chrome or Brave | 2. Open Chrome or Brave | ||||
3. Navigate to `chrome://extensions/` (or `brave://extensions/`) | 3. Navigate to `chrome://extensions/` (or `brave://extensions/`) | ||||
4. Enable Developer Mode | 4. Enable Developer Mode | ||||
5. Click "Load unpacked" | 5. Click "Load unpacked" | ||||
6. Select the `extension/dist` folder that was created with `npm run extension` | 6. Select the `extension/dist` folder that was created with `npm run extension` | ||||
## Docker deployment | ## Docker deployment | ||||
``` | ``` | ||||
npm install --legacy-peer-deps | npm install --legacy-peer-deps | ||||
majcosta: missed this | |||||
docker-compose build | docker-compose build | ||||
docker-compose up | docker-compose up | ||||
``` | ``` | ||||
## Redundant APIs | ## Redundant APIs | ||||
CashTab accepts multiple instances of `bch-api` as its backend. Input your desired API URLs separated commas into the `REACT_APP_BCHA_APIS` variable. For example, to run CashTab with three redundant APIs, use: | CashTab accepts multiple instances of `bch-api` as its backend. Input your desired API URLs separated commas into the `REACT_APP_BCHA_APIS` variable. For example, to run CashTab with three redundant APIs, use: | ||||
Show All 21 Lines |
missed this