safe-react/readme.md

Gnosis Team Safe

Allowing crypto users manage funds in a safer way

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

yarn add truffle // recommended usage of -g flag
yarn add ganache-cli // recommended usage of -g flag
yarn add flow-type // recommended usage of -g flag

We use yarn in our infrastacture, so we decided to go with yarn in the README

Installing and running

A step by step series of examples that tell you have to get a development env running

Run ganache in one terminal

ganache-cli -b 3

Start the project in the other one

yarn install
yarn start

For the mainnet version:

REACT_APP_NETWORK=mainnet yarn start

Building

For rinkeby:

yarn build

For mainnet:

REACT_APP_NETWORK=mainnet yarn build

Running the tests

1. Run transaction-history-service

git clone https://github.com/gnosis/safe-transaction-service.git
cd safe-transaction-history
git checkout develop
docker-compose build
docker-compose up -d

Check that the service is running at https://localhost:8000

2. Migrate Safe Contracts:

git clone https://github.com/gnosis/safe-contracts.git
cd safe-contracts
yarn
npx truffle migrate

3. Migrate Token Contracts for the tests: Inside safe-react directory

npx truffle migrate

4. Run the tests:

yarn test

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Truffle React Box - The web framework used
• Ganache - Fast Ethereum RPC client
• React - A JS library for building user interfaces
• Material UI 1.X - React components that implement Google's Material Design
• redux, immutable, reselect, final-form - React ecosystem libraries
• Flow - Sttic Type Checker

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Thanks for Gnosis Team for providing the Safe contracts.