Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 3.39 KB

README.md

File metadata and controls

115 lines (85 loc) · 3.39 KB

Gigacounts Frontend

Requirements

This App requires:

Install the dependencies

- yarn install # with yarn
- npm i OR npm i --legacy-peer-deps # with NPM

If you have troubles with dependencies, try this:

set http_proxy=
set https_proxy=
npm config rm https-proxy
npm config rm proxy
npm config set registry "https://registry.npmjs.org"
yarn cache clean
yarn config delete proxy
yarn --network-timeout 100000

Create a .env file running the command in terminal

touch .env

Environment variables

The environment variables bellow needs to be set in the .env file when project is running locally:

SKIP_PREFLIGHT_CHECK=true
GENERATE_SOURCEMAP=false
npm_config_user_agent=yarn
PORT=3000
REACT_APP_BACKEND_URL=http://127.0.0.1:3333
REACT_APP_DEFAULT_COUNTRY_CODE=US
REACT_APP_NOTIFICATIONS_REFRESH_INTERVAL_MS=5000
REACT_APP_KNOWLEDGE_BASE_URL=https://dappsar.github.io/jekyll-g
REACT_APP_WALLET_CONNECT_PROJECT_ID=(Project id defined in https://cloud.walletconnect.com/)
REACT_APP_NETWORK_ID=80001
REACT_APP_NODE_PROVIDER_URL=https://polygon-mumbai.g.alchemy.com/v2/
REACT_APP_NODE_PROVIDER_KEY=NODE_PROVIDER_API_KEY
REACT_APP_GIGACOUNTS_TOKEN_ADR=
REACT_APP_B2C_SIGNUP_SIGNIN_NAME=
REACT_APP_B2C_FORGOT_PASSWORD_NAME=
REACT_APP_B2C_EDIT_PROFILE_NAME=
REACT_APP_B2C_URL=
REACT_APP_B2C_DOMAIN=
REACT_APP_B2C_CLIENT_ID=

Some Variable description:

  • REACT_APP_BACKEND_URL: Represents the url for the connection to the database - set the url of the server api to connect to a specific database
  • REACT_APP_DEFAULT_COUNTRY_CODE: Reprepsents the default country id if users country is not in the country list
  • REACT_APP_NOTIFICATIONS_REFRESH_INTERVAL_MS: Represents the interval to refresh notificacions (list and avatar)
  • REACT_APP_KNOWLEDGE_BASE_URL: External Knowledge Base URL
  • REACT_APP_WALLET_CONNECT_PROJECT_ID: Is used to connect wallet with Wallet Connect Protocol
  • REACT_APP_NETWORK_ID: Is a property of the chain managed by the node. e.g (Polygon Mumbai Testnet = 80001)
  • REACT_APP_GIGACOUNTS_TOKEN_ADR: Smart Contract address of Gigacounts Tokens

Start app

- yarn start
# or
- npm 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.

If you want to start in local port with B2C, you must run:

PORT=6340 npm start

Then, login in B2C with the user that you create in Azure. Remember, that you have to configure the same users in your database.

TODO (Improvements)

  • Get the smart contract of the secondaryTokens based on the getCurrencies of the database, to remove the tokens environment variable.

Source Code additional Documentation

See ./doc/, for documentation about source code: routing, multi-language, dependencies, components, authenticaton, state-management, structure and flow, api calls, theme, etc.