@helloinspire/melodic

Melodic

Inspire's front-end design system for the Web.
Explore Melodic docs »

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Contributing
• Versioning
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/DWPHoldings/melodic-web.git
• Install with npm: npm install melodic@2.0.0-alpha
• Install with yarn: yarn add melodic@2.0.0-alpha
• Install with Rubygems: gem install melodic -v 2.0.0.alpha

Read the Getting started page for information on the framework contents, templates and examples, and more.

Status

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

melodic-web/
├── css/
│   ├── melodic.css
│   ├── melodic.css.map
│   ├── melodic.min.css
│   ├── melodic.min.css.map
│   ├── melodic-grid.css
│   ├── melodic-grid.css.map
│   ├── melodic-grid.min.css
│   ├── melodic-grid.min.css.map
│   ├── melodic-reboot.css
│   ├── melodic-reboot.css.map
│   ├── melodic-reboot.min.css
│   └── melodic-reboot.min.css.map
└── js/
    ├── melodic.bundle.js
    ├── melodic.bundle.min.js
    ├── melodic.js
    └── melodic.min.js

We provide compiled CSS and JS (melodic.*), as well as compiled and minified CSS and JS (melodic.min.*). CSS source maps (melodic.*.map) are available for use with certain browsers' developer tools. Bundled JS files (melodic.bundle.js and minified melodic.bundle.min.js) include Popper, but not jQuery.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Melodic's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://melodic.helloinspire.com/. The docs may also be run locally.

Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set debug: true in the _scripts.html include.

Running documentation locally

1. Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with bundle install.
2. Run npm install to install Node.js dependencies.
3. Run npm run test (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
4. From the root /melodic-web directory, run npm run docs-serve in the command line.
5. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Previous releases and their documentation are available for download.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org/.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Melodic is maintained under the Semantic Versioning guidelines.

See the Releases section of our GitHub project for changelogs for each release version of Melodic.

Creators and Maintainers

Thank you, Inspire Avengers and contributors.

Copyright and license

Code and documentation copyright 2011-2018 the Bootstrap Authors and Twitter, Inc. Portions copyright 2020 Inspire Energy Holdings, LLC. Code released under the MIT License. Docs released under Creative Commons.