platform-frontend

Running project

Prerequisites

• running ethereum node on port 8545. To start local instance just run yarn ganache
• running signature_auth_api on port 5000

yarn
yarn ganache   # in separate window. You need to upload neufund contracts. Keep on reading.
yarn start

Using external backend

Set NF_REMOTE_BACKEND_PROXY_ROOT variable in your .env file and run yarn start:remote to connect to remote backend.

Running production build locally

yarn build:prod # build production bundle

sh ./scripts/prod-like-srv.sh # run the server

Uploading contracts

To upload modified version of Neufund Smartcontract that allows for easier blockchain development you need to checkout kk/frontend-platform-fixtures branch and run yarn fixture.

Typechain (it generates typed wrappers on smartcontracts) runs automatically after doing yarn to trigger it manually do: yarn generate:contracts.

Running tests

yarn test # checks formatting, runs linter and tests

Fix all autofixable errors and run tests

yarn test:fix

Production build

yarn build:prod

Extracting translations from the app

yarn intl:extract

Read more

Update contract artifacts submodule

If you need to push the contract artifacts to the newest version yourself, then run.

yarn update-contract-artifacts

then commit the submodules change. It is important to commit before you run yarn, since the yarn prepare script will revert uncommited changes to git submodules, and repin them to the local version.

yarn

If somebody else committed a new version of the submodules, just run yarn, and everything will be updated

Take into account when pushing a PR that contains updated submodules. You will need to add #with-artifacts in the title of the pull request. Any pull request that contains contract artifacts without #with-artifacts as a title will get rejected by Danger in our CI pipeline

Docs

• Component Development Guidelines
• React Guidelines
• Testing production build
• Working with Intl
• Feature flags