Gnosis Safe

The most trusted platform to store digital assets on Ethereum

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 globally:

yarn global add truffle ganache-cli

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

Install dependencies for the project:

yarn install

For using the Rinkeby services:

yarn start

If you prefer using Mainnet ones:

yarn start-mainnet

Environment variables

The app grabs environment variables from the .env file. Copy our template to your own local file:

cp .env.example .env

To execute transactions, you'll need to create an Infura project and set the project ID in the .env you've just created:

REACT_APP_INFURA_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Once done, you'll need to restart the app.

Building

For Rinkeby:

yarn build

For Mainnet:

yarn build-mainnet

Running the tests

Run transaction-history-service

git clone https://github.com/gnosis/safe-transaction-service.git
cd safe-transaction-service
git checkout develop
docker-compose build
# it comes enabled by default in docker-compose
sudo service postgresql stop
docker-compose up -d

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

Migrate Safe Contracts:

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

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

npx truffle migrate

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

Configuring the app for running on different networks

Please check the network configuration documentation

Built With

Truffle React Box - The web framework used
Ganache - Fast Ethereum RPC client
React - A JS library for building user interfaces
Material UI 4.X - React components that implement Google's Material Design
redux, immutable, reselect, final-form - React ecosystem libraries
Flow - Static 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

Germán Martínez(germartinez)
Mikhail Mikheev(mikheevm)

See the full 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.

jenikd/safe-react