Running-One-App-Locally.md

👈 Return to Overview

Running One App Locally

To run One App locally, you need to make sure that you are on Node 18. After that, go ahead and clone One App:

git clone https://github.com/americanexpress/one-app.git

After it has finished cloning, cd into one-app and run npm install

In order to work with your modules locally, you will need to serve your modules to One App (make sure you run npm run build or npm run watch:build in your module beforehand):

npm run serve-module <path/to/your/module> <path/to/another/module>

Once you have your modules served to One App you can start One App.

By default when starting One App only your locally served modules will be used. If you have a remote module map you would like to have One App load use the module-map-url flag. Keep in mind that One App will combine your locally served modules with the remote module map. Locally served modules will override modules with the same name in the remote module map.

NODE_ENV=development npm start -- --module-map-url=<your-remote-module-map-url> --root-module-name=<your-root-module-name>

Useful Local Development Commands / Options

The drop-module command allows you to stop serving a module:

npm run drop-module <module-name>

The log-format option allows you to specify how you would like One App logs presented to you:

# available formats are `friendly`, `verbose`, and `machine`. Default is `friendly`
NODE_ENV=development npm start -- --log-format=friendly

The log-level option allows you to specify the lowest level of logs you would like One App to present to you:

# available formats are `error`, `warn`, `log`, `info`. Default is `log`
NODE_ENV=development npm start -- --log-level=warn

☝️ Return To Top