Topcoder Self Service Micro Frontend App

This is a single-spa example React microapp.

NOTE. This application have been configured to be run as child app of a single-spa application. So while this app can be deployed and run independently, we would need some frame single-spa which would load it. While technically we can achieve running this app as standalone app it's strongly not recommended by the author of the single-spa approch, see this GitHub Issue for details.

Requirements

• node - v10.22.1
• npm - v6.14.6

NPM Commands

Command	Description
npm start	Run server which serves production ready build from dist folder
npm run dev	Run app in the development mode and dev config
npm run dev-https	Run app in the development mode and dev config using HTTPS protocol
npm run local	Run app in the development mode and dev config
npm run prod	Run app in the development mode and prod config
npm run build	Build app for production and puts files to the dist folder, default to development mode and dev config
npm run analyze	Analyze dependencies sizes and opens report in the browser
npm run lint	Check code for lint errors
npm run format	Format code using prettier
npm run test	Run unit tests
npm run watch-tests	Watch for file changes and run unit tests on changes
npm run coverage	Generate test code coverage report
npm run mock-api	Start the mock api which mocks Recruit api

Local Deployment

Inside the project folder run:

• nvm use 10.22.1; - to use npm version: 10.22.1
• npm i - install dependencies
• npm run local - run app in development mode and dev config
• This app will be loaded as a normal MFE app, its url is http://localhost:8519/self-service/topcoder-micro-frontends-self-service-app.js and is configurated in the config file of Self Service App

Deployment to Production

• npm i - install dependencies
• npm build - build code to dist/ folder
• Now you can host dist/ folder using any static server. For example, you may run a simple Express server by running npm start.

Deploying to Heroku

Make sure you have Heroky CLI installed and you have a Heroku account. And then inside the project folder run the next commands:

• If there is not Git repository inited yet, create a repo and commit all the files:

  • git init
  • git add .
  • git commit -m'inital commit'

• heroku apps:create - create Heroku app

• git push heroku master - push changes to Heroku and trigger deploying

• Now you have to configure frame app to use the URL provided by Heroku like https://<APP-NAME>.herokuapp.com/gigs-app/topcoder-micro-frontends-self-service-app.js to load this microapp.

Aggregator API

Please refer to Swagger Doc for Aggregator API endpoints

Aggregator API Configuration

In the micro-frontends-self-service-app root directory create .env file with the next environment variables.

# Auth0 config
AUTH_SECRET=
AUTH0_URL=
AUTH0_AUDIENCE=
AUTH0_CLIENT_ID=
AUTH0_CLIENT_SECRET=
VALID_ISSUERS=

Once the self service app is started, the aggregator api will work as well