Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sundi3yansyah/stisla-rails

Free Bootstrap Admin Template for Rails
https://github.com/sundi3yansyah/stisla-rails

bootstrap bootstrap4 css javascript rails ruby ruby-on-rails stisla templates

Last synced: 25 days ago
JSON representation

Free Bootstrap Admin Template for Rails

Awesome Lists containing this project

README

        



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](https://camo.githubusercontent.com/2135e0f6544a7286a3412cdc3df32d47fc91b045/68747470733a2f2f692e6962622e636f2f3674646d6358302f323031382d31312d31312d31352d33352d676574737469736c612d636f6d2e706e67)](https://getstisla.com)

## Table of contents

- [Status](#status)
- [Link Stisla](#link-stisla)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#License)

## Status

[![Build Status](https://travis-ci.org/SunDi3yansyah/stisla-rails.svg)](https://travis-ci.org/SunDi3yansyah/stisla-rails)
[![License](https://img.shields.io/github/license/SunDi3yansyah/stisla-rails.svg)](LICENSE)
[![Gem Version](https://badge.fury.io/rb/stisla-rails.svg)](https://badge.fury.io/rb/stisla-rails)
[![Download total](https://img.shields.io/gem/dt/stisla-rails.svg?style=flat)](https://badge.fury.io/rb/stisla-rails)
[![GitHub last commit](https://img.shields.io/github/last-commit/SunDi3yansyah/stisla-rails.svg)](https://github.com/SunDi3yansyah/stisla-rails/commits/master)
[![GitHub issues](https://img.shields.io/github/issues/SunDi3yansyah/stisla-rails.svg)](https://github.com/SunDi3yansyah/stisla-rails/issues)

## Link Stisla
- Homepage: [getstisla.com](https://getstisla.com)
- Repository: [github.com/stisla/stisla](https://github.com/stisla/stisla)
- Documentation: [getstisla.com/docs](https://getstisla.com/docs)

## Installation

Add this line to your application's Gemfile:

``` ruby
gem 'stisla-rails'
```

And then execute:

``` bash
$ bundle
```

Or install it yourself as:

``` bash
$ 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:

```bash
$ 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`
```bash
rails g stisla_rails:install
```

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

``` scss
// ... other stuff

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

// ... other stuff
```

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

``` js
// ... 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`
```bash
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](https://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](http://contributor-covenant.org) 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](CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](LICENSE).