Collection of components and utilities to facilitate developing web applications integrating Ruby helpers to facilitate the generation of HTML templates, Bulma componentes with some customizations and StimulusJS controllers to provide the functionality to those components.
Add this line to your application's Gemfile:
gem 'frontend_helpers', github: 'Grupo-AFAL/frontend-helpers', branch: 'main'And then execute:
$ bundle install
TODO: Write how to use Ruby helpers
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
yarn add https://github.com/Grupo-AFAL/frontend-helpers.git
All controllers have dependency on StimulusJS which is a peerDependency of this package.
import { Application } from '@hotwired/stimulus'
import { DropdownController } from 'frontend-helpers'
const application = Application.start()
application.register('dropdown', DropdownController)The javascript code live under the javascript folder.
npm run start
A browser window will open at localhost:8080
New controllers go in src/controllers and utility functions go in src/utils
For new components create a HTML file in docs/ to test out the controller being developed.
CSS is expected to be loaded by the Asset Pipeline and is available to @import into the application.scss
@import 'fe_base';TODO: Write how to use SCSS
Bug reports and pull requests are welcome on GitHub at https://github.com/Grupo-AFAL/frontend-helpers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the FrontendHelpers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.