Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leckylao committed Apr 30, 2020
1 parent e5391db commit 87a7450
Showing 1 changed file with 16 additions and 60 deletions.
76 changes: 16 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,24 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Name of Project
Gnosis Safe Recovery Module - Created by Lecky Lao

## Available Scripts
## Project Description
This demo shows how to enable recovery answers and how to recover the safe using these answers on another account

In the project directory, you can run:
## Implementation
This was built with React and Solidity. You can run truffle test to run all tests and yarn start to start the app in local environment.

### `yarn start`
## Deployment
The contracts are deployed on Rinkeby and can be checked at https://github.com/leckylao/gnosis-hack/blob/master/contracts/AnswerRecoveryModule.sol. And the demo has been deployed on https://leckylao.github.io/gnosis-hack/

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
For more visualization, check the Demo: https://youtu.be/eSQhHdYlpyg

The page will reload if you make edits.<br />
You will also see any lint errors in the console.
## Project Team

### `yarn test`
Lecky Lao
[@leckylao](https://www.linkedin.com/in/leckylao)

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
## Github Repo
https://github.com/leckylao/gnosis-hack

### `yarn build`

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.

The build is minified and the filenames include the hashes.<br />
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).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

### Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

### Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

### Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

### Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

### `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
## Video Demo
https://youtu.be/eSQhHdYlpyg

0 comments on commit 87a7450

Please sign in to comment.