/rds

Primary LanguageHTMLMIT LicenseMIT

rds-docs

Let my heart be still a moment and this mystery explore...

Getting Started

Clone repo

Clone this repo [ https://github.com/ravendesignsystem/rds.git ] into the directory you need it to be in.

Install Dependencies

Install NPM packages

From package.json run npm install.

Install Sculpin

Install all packages from composer.json.

Running RDS Locally

  • To launch Sculpin, run the npm run sculpin.
  • In a new terminal, run npm run watch to invoke the Laravel Mix watch.

FIX Post-CSS module

For some reason the

Go to /node_modules/css-mqpacker/index.js:139 and remove the ...options line.

So lines 136-139 should look like this:

     const opts = {
       sort: false
     };

Danny has submitted an issue to the maintainer. Weird.

TODO - resolve this.

Break down into end to end tests

TODO

Deployment

TODO

RDS Built With

  • SCSS - CSS superpower provider used
  • Love - <3

Documentation Website Built With

TODO

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • TODO

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • We've stood on the backs of giants for sure.
  • Inspiration
  • TODO