Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 1.78 KB

README.md

File metadata and controls

52 lines (41 loc) · 1.78 KB

Milo

Milo is a shared set of features and services to power Franklin-based websites on adobe.com. If you wish to create your own milo-based project, please use the College project as your foundation.

codecov

Environments

Preview | Live

Developing

  1. Install the Helix CLI: sudo npm install -g @adobe/helix-cli
  2. Run hlx up this repo's folder. (opens your browser at http://localhost:3000)
  3. Open this repo's folder in your favorite editor and start coding.

NPM (Recommended)

While milo does not require a build step to function, you will need to install npm packages (npm install) to:

  1. Lint
  2. Test
  3. Run libs

Tool recommendations

You can use any text editor or IDE of your choice, but milo is highly optimized for VS Code. Milo provides recommended extensions (use the filters) and debugging tools.

Libs

If you want to see how your milo changes impact a consuming site you will need to work on a different port.

npm run libs

Milo will run at:

http://localhost:6456

You can then test any of the following:

http://localhost:3000/?milolibs=local (local code, stage content)

https://main--project--owner.hlx.page/?milolibs=local (prod code, stage content)

https://main--project--owner.hlx.live/?milolibs=local (prod code, prod content)

https://feat-branch--project--owner.hlx.page/?milolibs=local (feature code, stage content)

Testing

npm run test

or:

npm run test:watch

This will give you several options to debug tests. Note: coverage may not be accurate.