Skip to content

xiongemi/white-label-airline

Repository files navigation

White Label Airline React

NOTE: the API skyscanner API NO longer works.

Blog Post:

This project is a sample flight search app generated using Nx.

alt text

Medium Blog: https://medium.com/swlh/how-to-create-a-white-label-react-app-137c06ae24ad

Structure

libs: commonly shared files
|__services: API services, response models, or wrapper for third-party libraries (i18n)
|__models: commonly shared models that are independent of backend API response models
|__store: state management related files
|__ui: commonly shared UI comopnents
apps: applications that consume libs, in this example
|__white-label-airline: a sample app with all feature toggles and en-GB as default locale
|__abc-airline: a sample app with all feature toggles off and zh-CN as default locale

Commands

  • deploy to GitHub Pages: npm run deploy
  • run apps locally: npm run serve (white-label-airline) or nx serve abc-airline

Unit Test

  • test apps: nx test white-label-airline or nx test abc-airline
  • test libraries: nx test ui or nx test services or nx test store
  • test all files: npm run test
  • test watch all files: npm run test:watch
  • clear cache: npm run test:clear

Lint

  • run lint for all libraries and applications: npm run lint
  • run lint with fix for all libraries and applications: npm run lint:fix

i18n

  • extract translation keys: npm run i18n:<app name>. For example, i18n:abc-airline will extract translation key for app abc-airline

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • React
    • npm install --save-dev @nrwl/react
  • Web (no framework frontends)
    • npm install --save-dev @nrwl/web
  • Angular
    • npm install --save-dev @nrwl/angular
  • Nest
    • npm install --save-dev @nrwl/nest
  • Express
    • npm install --save-dev @nrwl/express
  • Node
    • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run nx g @nrwl/react:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are sharable across libraries and applications. They can be imported from @white-label-airline/mylib.

Development server

Run nx serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

Build

Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run nx test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.