Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marionettejs/marionettejs.com
:triangular_flag_on_post: Source files for the Marionette site
https://github.com/marionettejs/marionettejs.com
Last synced: about 2 months ago
JSON representation
:triangular_flag_on_post: Source files for the Marionette site
- Host: GitHub
- URL: https://github.com/marionettejs/marionettejs.com
- Owner: marionettejs
- License: mit
- Created: 2014-07-08T02:30:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T06:43:42.000Z (over 1 year ago)
- Last Synced: 2024-04-12T19:18:20.950Z (9 months ago)
- Language: Pug
- Homepage: https://marionettejs.com
- Size: 15.9 MB
- Stars: 26
- Watchers: 16
- Forks: 32
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
marionettejs.com
================[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/marionettejs/marionettejs.com?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/marionettejs/marionettejs.com.svg?branch=master)](https://travis-ci.org/marionettejs/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](https://github.com/motdotla/dotenv) 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](http://localhost:8000).
Site is using service worker ([sw-precache](https://github.com/GoogleChrome/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](./svg-steps.md)
## Submitting PR
Before submitting pull request, please, run `npm test` and make sure that tests are not broken.