jiwoo-choi / marionettejs.com

:triangular_flag_on_post: Source files for the Marionette site

marionettejs.com

Setup

To prep your repo, all you need to do is run our setup script.

npm run setup

Create file .env in a root folder and in test\compilers with data:

AUTH_TOKEN='your_github_outh_token'

Read more about .env;

After that, development should be easy! Use our dev task to get everything up and running:

npm run dev

Then visit http://localhost:8000.

Site is using service worker (sw-precache), so it can be used in offline mode. All resources are cached during build.

It uses YouTube and GitHub API for getting data dynamically.

Compiling the docs

Working on the docs is just as easy as working on the website. Run the dev task as mentioned above but make sure you also compile the docs:

npm run compile-docs

You'll need to rerun this command after template changes.

When adding SVG

Follow these steps

Submitting PR

Before submitting pull request, please, run npm test and make sure that tests are not broken.