Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Amanda Gonsalves committed Aug 30, 2021
1 parent c98813f commit 5500827
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 24 deletions.
33 changes: 11 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,34 @@
# First App for the Pali Wallet Documentation

This is an test model App for the Pali Wallet. It follows the usage in the _Getting Started_ section of the [Pali Wallet Documentation](https://pali-docs.vercel.app/guide/Getting_Started.html). Some ready-to-use functions are commented in the /src/App.js file.

If you are searching for the `signTransaction()` App, continue to the SingTX folder.
This is an test model App for the Pali Wallet. It follows the usage in the _Getting Started_ section of the [Pali Wallet Documentation](https://pali-docs.vercel.app/guide/Getting_Started.html). All the ready-to-use functions are commented in the /src/App.js file, including all the sign functions.

After downloading, you should start with `yarn install` and then `ỳarn start`.

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). The following is a series of commands for React.

## Pali Wallet sign methods

To call signAndSend() or signPSBT() methods you will need to run a server in the root folder using:

`yarn server`

## Available Scripts

First install the project dependencies:

### `yarn install`
`yarn install`

In the project directory, you can run:

### `yarn start`
`yarn start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`
`yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
Expand All @@ -39,16 +38,6 @@ Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
Expand Down Expand Up @@ -77,4 +66,4 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/d

### `yarn build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"server": "node server/app.js"
},
"eslintConfig": {
Expand Down

0 comments on commit 5500827

Please sign in to comment.