https://github.com/fernandes/arara
A material design theme for Ruby on Rails 🦜
https://github.com/fernandes/arara
actionview-component arara material-design rails ruby ruby-on-rails stimulusjs
Last synced: 18 days ago
JSON representation
A material design theme for Ruby on Rails 🦜
- Host: GitHub
- URL: https://github.com/fernandes/arara
- Owner: fernandes
- License: mit
- Created: 2020-02-24T01:59:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T00:50:29.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T16:44:58.886Z (21 days ago)
- Topics: actionview-component, arara, material-design, rails, ruby, ruby-on-rails, stimulusjs
- Language: HTML
- Homepage:
- Size: 1.16 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arara 🦜
## Browser Sync
```bash
browser-sync start --proxy localhost:3000 --files "app/views, app/concepts"
```
## Customizing Dynamically
```css
:root {
--base-color: #c6538c;
}
body {
background-color: var(--base-color);
}
```
```js
var root = document.documentElement;
root.style.setProperty('--base-color', "palevioletred")
```
## Developing
All arara related files are inside `app/javascript/arara`, the folder contains:
- controllers : with all the stimulus controllers
- scss : the basic scss setup
### Demo
TL;DR (quick setup)
```bash
yarn
cd test/dummy
yarn
bundle install
rails server
```
On project root run the `yarn` (or `npm`) command to install the dependencies for arara
To run the demo, go inside `test/dummy` and run the commands:
- bundle install
- yarn/npm (now is needed to install the demo dependencies)
and run the commands on two different terminals:
- ./bin/webpack-dev-server
- rails s
Access http://localhost:3000 to see it running
## NPM Package
This is my first NPM package, the built system was inspired on [ActionCable](https://github.com/rails/rails/blob/ec69083cf3352c78f840de50fdf20ef30334e0b1/actioncable/package.json#L49) and [Material-UI](https://github.com/mui-org/material-ui/blob/49fb53dd3497e3c825bab92f1f1dde42644dbab4/package.json#L33), if there's a bug (and probably there ARE) or you have any suggestion, please open an issue
## Special Thanks ✨
Eu gostaria de agradecer aos colegas @nicolasiensen @lpirola @lucastx @igr-santos @vivianedias que gentilmente cederam o nome da gem no rubygems.
I'd like to say thank you to @nicolasiensen @lpirola @lucastx @igr-santos @vivianedias that gently let me use the gem name on rubygems
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).