Merge branch 'master' of github.com:victaphu/explorer-v2-frontend

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+## Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, discord server or any other method with the owners of this repository before making a change.
+
+### Pull Request Process
+1) Fork a [repository](https://github.com/harmony-one/explorer-v2-frontend) and create your branch from `master`;
+2) Run `yarn build` in the repository root
+3) Update .env.example if new environment variables is created;
+4) Create pull request linked with existed issue.
+
+### Branch Organization
+
+Submit all changes directly to [master branch](https://github.com/harmony-one/explorer-v2-frontend/tree/master).
+We don’t use separate branches for development or for upcoming releases.
+
+### Bugs
+We are using [Github Issues](https://github.com/harmony-one/explorer-v2-frontend/issues) for tracking bugs.
+Before creating a new issue please check that problem doesn't already exist.
+
+### Proposing a Change
+If you have a suggestion on how to improve functionality or create a new feature you can [fill a new issue](https://github.com/harmony-one/explorer-v2-frontend/issues/new).

README.md

@@ -1,48 +1,44 @@
-# Getting Started with Create React App
+# Harmony Explorer frontend
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Requirements
 
-## Available Scripts
+### Node.js 16.13.2 LTS
+Download and install Node.js from the official website: [https://nodejs.org/](https://nodejs.org/)
 
-In the project directory, you can run:
+### yarn 1.22.17
 
-### `yarn start`
+```
+npm install --global yarn
+```
 
-Runs the app in the development mode.\
+## Dev Environment
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-The page will reload if you make edits.\
+### First Install
-You will also see any lint errors in the console.
 
-### `yarn test`
+1) Clone repo:
 
-Launches the test runner in the interactive watch mode.\
+```bash
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+git clone https://github.com/harmony-one/explorer-v2-frontend.git
+```
+2) Install dependencies:
+```bash
+cd explorer-v2-frontend
+yarn install
+```
+3) Run project:
+```bash
+yarn start
+```
+4) Open app page http://localhost:3000/
 
-### `yarn build`
+### Configuring app
 
-Builds the app for production to the `build` folder.\
+1) Create a new file: `.env.local`
-It correctly bundles React in production mode and optimizes the build for the best performance.
+2) Copy env variables from `.env.example` to newly created file `.env.local`
+3) Setup custom env variables values and restart the app
 
-The build is minified and the filenames include the hashes.\
+### Build
-Your app is ready to be deployed!
+To create production build run command:
-
+```
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+yarn build
-
+```
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).