Skip to content

SunDi3yansyah/stisla-rails

Repository files navigation

Stisla logo

Stisla for Rails

Stisla is Free Bootstrap Admin Template and will help you to speed up your project, design your own dashboard UI and the users will love it.

Stisla Preview

Table of contents

Status

Build Status License Gem Version Download total GitHub last commit GitHub issues

Link Stisla

Installation

Add this line to your application's Gemfile:

gem 'stisla-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stisla-rails

Usage

Make sure the file has .scss extension (or .sass for Sass syntax). If you have just generated a new Rails app, it may come with a .css file instead. If this file exists, it will be served instead of Sass, so rename it:

$ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss

Then, remove all the *= require_self and *= require_tree . statements from the sass file. Instead, use @import to import Sass files.

Do not use *= require in Sass or your other stylesheets will not be [able to access][antirequire] the Bootstrap mixins or variables.

Generate the Stisla Rails configuration file and a new package in package.json

rails g stisla_rails:install

Open app/assets/stylesheets/application.scss then put like this:

// ... other stuff

@import "style";
@import "components";

// ... other stuff

Open app/assets/javascript/application.js then put like this:

// ... other stuff

//= require stisla
//= require scripts
//= require custom

// ... other stuff

Font Awesome

There is a problem if you use sources from node_modules whether it's css or scss, maybe this is a temporary solution that you can use.

Generate fontawesome to app/assets/fonts

rails g stisla_rails:fontawesome

Then you can add lib/fontawesome wherever you want to use it.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SunDi3yansyah/stisla-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Stisla::Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

The gem is available as open source under the terms of the MIT License.