README.md

Token Bridge for StarkNet

StarkNet is a permissionless decentralized Rollup operating as an L2 network over Ethereum.
The StarkNet bridge allows users to transfer ERC20 tokens from Ethereum to StarkNet and vice versa.

This project was bootstrapped with Create React App.

Prerequisites

1. Install NPM and Node.js. See Guide.
2. Make sure you've yarn installed globally on your machine npm i -g yarn.

Installation

Clone and run yarn to install dependencies:

git clone https://github.com/starkware-libs/starkgate-frontend.git
cd starkgate-frontend
yarn install

Development

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Production

yarn build

Builds the app for production to the build folder.
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.
Your app is ready to be deployed!

.env Files

.env files are increasingly popular as a way to configure an application. Their values are injected into the application bundle during build time.
The appropriate files are loading according to the NODE_ENV value.
.env (global values for all environments)
.env.development (values for development env, i.e NODE_ENV=development)
.env.test (values for testing env, i.e, NODE_ENV=test)
.env.production (values for production env, i.e, NODE_ENV=production)

Note: each file can be overridden on a local environment using matching .env.[ENV].local file.

Wallet Support

WIP

Tokens Support

WIP

Project Structure

WIP

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

WIP