Code Monkey home page Code Monkey logo

milo's Introduction

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

Getting started

TL;DR

  1. Clone this repo to your computer.
  2. Install the AEM CLI: sudo npm install -g @adobe/aem-cli
  3. In a terminal, run aem up this repo's folder.
  4. Start coding.

Detailed

  1. Fork this repo.
  2. Install the AEM Code Sync on your forked repo.
  3. Clone your forked repo down to your computer.
  4. Install the AEM CLI using your terminal: sudo npm install -g @adobe/aem-cli
  5. In a terminal, run aem up your repo's folder on your computer. It will open a browser.
  6. Open your repo's folder in your favorite code editor and start coding.

Even more detailed

See the wiki for more detailed instructions on how to get started writing features for Milo.

Tooling

NPM (Recommended)

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

  1. Lint
  2. Test
  3. Run libs

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 local 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

Coverage

npm run test:watch can give misleading coverage reports. Use npm run test for accurate coverage reporting.

milo's People

Contributors

3ch023 avatar aishwaryamathuria avatar amauch-adobe avatar auniverseaway avatar axelcureno avatar blainegunn avatar brandon32 avatar chrischrischris avatar cmiqueo avatar elan-tbx avatar fullcolorcoder avatar hparra avatar jasonhowellslavin avatar meganthecoder avatar mokimo avatar narcis-radu avatar overmyheadandbody avatar rgclayton avatar robert-bogos avatar ruchika4 avatar ryanmparrish avatar sanrai avatar sartxi avatar seanchoi-dev avatar sharath-kannan avatar sukamat avatar vgoodric avatar vhargrave avatar vkniaz avatar yesil avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.