Celo Safe

A fork of the most trusted platform to store digital assets on Ethereum. More info at gnosis-safe.io

For technical information please refer to the Gnosis Developer Portal.

For support requests, please open up a bug issue

Production deployments

This repository contains the code for the frontend code hosted at https://safe.celo.org

Besides the Celo Mainnet, the following networks are supported:

• Alfajores Testnet
• Baklava Testnet

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

We use yarn in our infrastructure, so we decided to go with yarn in the README. Please install yarn globally if you haven't already.

Environment variables

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

cp .env.example .env

Installing and running

Install dependencies for the project:

yarn install

To use the Alfajores services:

yarn start

If you prefer using the Mainnet ones:

yarn start-mainnet

If you prefer to use Docker:

docker-compose build && docker-compose up

Building

For Alfajores:

yarn build

For Mainnet:

yarn build-mainnet

Running the tests

To run the tests:

yarn test

Lint

ESLint will be run automatically before you commit. To run it manually:

yarn lint:fix

Deployment

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.

When pushing to the main branch, the code will be automatically deployed to staging.

Production

Deployment to production is done manually. Please see the release procedure notes for details.

Configuring the app for running on different networks

Please check the network configuration documentation

Built With

• 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

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.

License

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