diff --git a/.env.example b/.env.example deleted file mode 100644 index 28c8161cdc..0000000000 --- a/.env.example +++ /dev/null @@ -1,32 +0,0 @@ -# You can leave this empty for rinkeby or use "mainnet" -REACT_APP_NETWORK= - -# For all environments -REACT_APP_GOOGLE_ANALYTICS= -REACT_APP_INFURA_TOKEN= -REACT_APP_IPFS_GATEWAY=https://ipfs.io/ipfs -REACT_APP_SENTRY_DSN= - -# For production environments -REACT_APP_BLOCKNATIVE_KEY= -REACT_APP_INTERCOM_ID= -REACT_APP_PORTIS_ID= -REACT_APP_SQUARELINK_ID= -REACT_APP_FORTMATIC_KEY= -REACT_APP_OPENSEA_API_KEY= -REACT_APP_COLLECTIBLES_SOURCE= -REACT_APP_ETHERSCAN_API_KEY= -REACT_APP_ETHGASSTATION_API_KEY= - -# Versions -REACT_APP_LATEST_SAFE_VERSION= - -# Leave it untouched, version will set using dotenv-expand -REACT_APP_APP_VERSION=$npm_package_version - -# For Apps -REACT_APP_GNOSIS_APPS_URL=https://safe-apps.staging.gnosisdev.com - -# Contracts Addresses -REACT_APP_SPENDING_LIMIT_MODULE_ADDRESS=0x9e9Bf12b5a66c0f0A7435835e0365477E121B110 - diff --git a/README.md b/README.md index 3949e4e0e9..52ecfc14d9 100644 --- a/README.md +++ b/README.md @@ -1,115 +1,129 @@ -# Gnosis Safe +# Harmony Safe Multisig -The most trusted platform to store digital assets on Ethereum. More info at [gnosis-safe.io](https://gnosis-safe.io/) - -This repository contains the code for the frontend code hosted at [https://gnosis-safe.io/app/] - -Besides the Ethereum Mainnet, the following networks are supported: - -- [Rinkeby Testnet](https://rinkeby.gnosis-safe.io/app/) -- [xDai](https://xdai.gnosis-safe.io/app/) -- [Energy Web Chain](https://ewc.gnosis-safe.io/app/) -- [Volta Testnet](https://volta.gnosis-safe.io/app/) - -For technical information please refer to the [Gnosis Developer Portal](https://docs.gnosis.io/safe/). - -For support requests, please open up a [bug issue](https://github.com/gnosis/safe-react/issues/new?template=bug-report.md) or reach out via [Discord](https://discordapp.com/invite/FPMRAwK). +The most trusted platform to store digital assets on Harmony ## 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](#deployment) for notes on how to deploy the project on a live system. +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 -We use [yarn](https://yarnpkg.com) in our infrastructure, so we decided to go with yarn in the README. -Please install yarn globally if you haven't already. +What things you need to install the software and how to install them -### Environment variables -The app grabs environment variables from the `.env` file. Copy our template to your own local file: ``` -cp .env.example .env +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 ``` -To execute transactions, you'll need to create an [Infura](https://infura.io) 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 if it's already running. +We use [yarn](https://yarnpkg.com) 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 ``` -To use the Rinkeby services: +For using the Testnet services: + ``` yarn start ``` -If you prefer using the Mainnet ones: +If you prefer using Mainnet ones: + ``` yarn start-mainnet ``` ### Building -For Rinkeby: + +For Testnet: + ``` yarn build ``` For Mainnet: + ``` yarn build-mainnet ``` ## Running the tests -To run the tests: +1. Run `transaction-history-service` + ``` -yarn test +git clone https://github.com/harmony-one/multisig-react.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 ``` -### Lint +Check that the service is running at https://localhost:8000 -ESLint will be run automatically before you commit. To run it manually: +2. Migrate Safe Contracts: ``` -yarn lint:fix +git clone https://github.com/harmony-one/multisig-contracts.git +cd safe-contracts +yarn +npx truffle migrate ``` -## Deployment +3. Migrate Token Contracts for the tests: + Inside `safe-react` directory + +``` +npx truffle migrate +``` -### Dev & staging -The code is deployed to a testing website automatically on each push via a GitHub Action. -The GitHub Action will create a new subdomain and post the link as a comment in the PR. +4. Run the tests: -When pushing to the `master` branch, the code will be automatically deployed to [staging](https://safe-team-rinkeby.staging.gnosisdev.com/). +``` +yarn test +``` -### Production -Deployment to production is done manually. Please see the [release procedure](docs/release-procedure.md) notes for details. +### Break down into end to end tests -## Configuring the app for running on different networks +Explain what these tests test and why -[Please check the network configuration documentation](./docs/networks.md) +``` +Give an example +``` -## Built With +### And coding style tests -* [React](https://reactjs.org/) - A JS library for building user interfaces -* [Material UI 4.X](https://material-ui.com/) - React components that implement Google's Material Design -* [redux, immutable, reselect, final-form](https://redux.js.org/) - React ecosystem libraries +Explain what these tests test and why - +``` +Give an example +``` -## Contributing +## Deployment -Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. +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](./docs/networks.md) -## Versioning +## Contributing -We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/gnosis/gnosis-team-safe/tags). +Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details + +## Acknowledgments + +- Thanks for Gnosis Team for providing the Safe contracts. diff --git a/public/favicon.ico b/public/favicon.ico index 85cacafc91..97d02f875c 100644 Binary files a/public/favicon.ico and b/public/favicon.ico differ diff --git a/public/index.html b/public/index.html index ac3e48c24c..725affffef 100644 --- a/public/index.html +++ b/public/index.html @@ -5,7 +5,7 @@ -

