Development setup
Even if you would like to adapt the application to your needs or you'd like to contribute to Atlas, here are the steps to follow in order to make the application up and running:
First of all, prepare your development environment and ensure you have installed the following useful prerequisites:
Visual Studio Code: https://code.visualstudio.com/download
Git Extensions: https://github.com/gitextensions/gitextensions/releases
Node.js: https://nodejs.org/en/download/
React application configuration
Step 1: Go to .env configuration file from react-ui folder and set the following variables with your own values:
REACT_APP_IDENTITY_CLIENT_ID: This should be the public identifier of Atlas
REACT_APP_IDENTITY_SCOPE: The list of scopes requested that will be present in the JWT token
REACT_APP_IDENTITY_AUTHORITY: The url to your Identity Server
REACT_APP_GQL: By default, the GQL Server runs on port 5000, but if that port will be changed, the new value must be configured here so the front-end application can communicate with the server side
REACT_APP_USE_NBB_MESSAGE: If you use the .Net Building Blocks for your messaging communication, which comes with its specific message structure, you would have to set this value to
true, otherwise it will befalse.
Step 2: Run the following commands to start the project
yarn install
yarn startStep 3: Check the application at: http://localhost:3000
Graph-QL Server configuration
Step 1: Go to .env configuration file from gql-bff folder and set the following variables with your own values:
REACT_APP_IDENTITY_AUTHORITY: The url to your Identity Server
IDENTITY_OPENID_CONFIGURATION ???
ELASTIC_SEARCH_HOST
API_URL
BASE_API_URL
IS_MULTITENANT
Step 2: Set up the Elastic connection by running the following commands in a PowerShell terminal/command prompt:
$env:KUBECONFIG=[insert path to the kubeconfig file for QA]
kubectl port-forward svc/elasticsearch-master [portNumber]:9200 -n elasticStep 3: Run the following commands to start the project
yarn install
yarn startStep 4: Check the Elastic is running at: http://localhost:9000
Step 5: Check the GQL server is running at: http://localhost:5000/graphql
Congratulations, you're all set! π ππ
Last updated