- Node v12.5 or higher installed on your machine.
- A decent code editor like VS Code or Atom.
- Git
- NPM
If using NPM(Preffered):
$ npm install
$ npm run start:local'npm install' to install the dependencies. 'npm run start:local' to run the application
To get started, make sure you have:
Step1: Clone the App To clone the code, navigate to the source directory where you want to maintain the code and via terminal or GUI of your choice, run : git clone https://github.com/OneCommunityGlobal/HighestGoodNetworkApp.git . You can also setup SSH and then use that for working with remote.
Step2: Run npm install root directory.
Step3: Start the app:
Option 1: To start the app, you need to set up the api endpoint as a process.env variable. Setup tokenKey as same as in HGNRest server. RestApi needs to be followed by '/api'. For example if HGNRest server is hosted at http://localhost:4500, the RestApi is http://localhost:4500/api . You can just run
REACT_APP_APIENDPOINT=<put apiendpoint here> npm start
For a windows user, you can run
set REACT_APP_APIENDPOINT=<put apiendpoint here> && npm start
Option 2 (Preferred): You can also create a .env file in the base directory with the following or ask a team member on slack to recieve a copy of this file for both the frontend and backend: REACT_APP_APIENDPOINT="" SKIP_PREFLIGHT_CHECK=true
npm run start:local
You may have to run it as super user (i.e. sudo) depending upon the permission setup on your machine. The application, by default, starts on port 3000. If 3000 is busy, then the start process will suggest another port and you can choose that. The url, by default, will be http://localhost:3000. You will need to login and those credentials will be provided to you as a part of your user setup process.
Note: Once you check in the code in github and get it reviewed, the application will be published to the following:
- Development : https://hgnapplication_react_dev.surge.sh
- Master: https://hgnapplicationv2.surge.sh
Other key touchpoints:
- Build: CircleCI
- Monitoring and logging: Sentry.io