https://github.com/fians/Waves

Click effect inspired by Google's Material Design
https://github.com/fians/Waves

Last synced: 3 months ago
JSON representation

Click effect inspired by Google's Material Design

• Host: GitHub
• URL: https://github.com/fians/Waves
• Owner: fians
• License: mit
• Created: 2014-07-14T12:12:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T04:37:25.000Z (about 2 years ago)
• Last Synced: 2024-05-15T15:04:32.587Z (8 months ago)
• Language: JavaScript
• Homepage: http://fian.my.id/Waves/
• Size: 693 KB
• Stars: 3,468
• Watchers: 124
• Forks: 504
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-indo-projects - Waves - Click effect inspired by Google's Material Design. (Front-end Development)
• awesome-material - Waves
• awesome-indonesia-repo - Waves - Click effect inspired by Google's Material Design. (Front-end Development)
• awesome-star-libs - fians / Waves

README

        
# Waves

Click effect inspired by Google's Material Design

http://fian.my.id/Waves/

## Documentation

Waves uses [Situs](https://github.com/fians/situs) to generate documentation. Here are some steps to run documentation locally on your computer:

1. Make sure [Node.js](http://nodejs.org/) and [Ruby](https://www.ruby-lang.org/en/) are installed in your computer.

2. Install SASS via RubyGems (`gem install sass`).

3. Install Situs globally via npm (`npm install situs -g`).

4. Clone Waves's Github repository, if you haven't already (`git clone https://github.com/fians/Waves.git`).

5. Run `npm install` to install the necessary local node packages.

6. Install grunt globally with `npm install -g grunt-cli`.

7. Run `grunt` to watch the directory, or simply `grunt build` to do a single build.

8. Now just start Situs server (`situs server`), then visit [http://localhost:4000/](http://localhost:4000/) on your browser.

## License

Waves is created by [Alfiana Sibuea](http://fian.my.id), and released under [MIT license](https://github.com/fians/Waves/blob/master/LICENSE). 

Copyright © 2014-2018 Alfiana E. Sibuea. All rights reserved.