/falcon-module-overrides

Example of overriding components in Deity Falcon

Primary LanguageJavaScript

Shop with Blog Example with custom modules that override default modules from @deity/falcon-ui and @deity/falcon-ecommerce-uikit (based on Deity Falcon v1.0-rc2)

Take a look at this commit to see how you can override module from @deity/falcon-ui Take a look at this commit to see how you can override module from @deity/falcon-ecommerce-uikit

In short all you have to do is to implement your module and add override instruction to moduleOverride map in client/falcon-client.build.config.js. For the modules mentioned above it looks like that:

  moduleOverride: {
    "@deity/falcon-ui/dist/components/Button": "./src/components/Button",
    "@deity/falcon-ecommerce-uikit/dist/Header/Header": "./src/components/Header"
  }

This is a template which is used by create-falcon-app to create a shop with blog app.

Quick Start

The best place to start is to use create-falcon-app.

Or download the example or clone the whole project:

Install it and run:

yarn install
yarn start

Then open http://localhost:3000/ to see your app.

That's it. Just start editing ./src/App.js and go!

Testing

To run tests:

yarn test

This will run the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

Debugging

To run with debugger:

yarn start:dbg

This will start application with enabled inspector agent.

If the server should wait till debugger will attache then run:

yarn start:dbg-brk

For more information, see falcon-client start command.

Production package

To build and run production package:

yarn build
yarn start:prod

You could view your application at http://localhost:3000

More information

If you would like to find more information please check out the official documentation website https://falcon.deity.io/