Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkhairi/fullcalendar
Fullcalendar+scheduler ruby gem
https://github.com/mkhairi/fullcalendar
fullcalendar fullcalendar-rubygem fullcalendar-scheduler fullcalendar-scheduler-rubygem rails scheduler-rubygem
Last synced: 2 months ago
JSON representation
Fullcalendar+scheduler ruby gem
- Host: GitHub
- URL: https://github.com/mkhairi/fullcalendar
- Owner: mkhairi
- License: mit
- Created: 2018-01-09T06:38:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-29T10:17:10.000Z (almost 5 years ago)
- Last Synced: 2024-05-01T13:36:43.158Z (9 months ago)
- Topics: fullcalendar, fullcalendar-rubygem, fullcalendar-scheduler, fullcalendar-scheduler-rubygem, rails, scheduler-rubygem
- Language: Ruby
- Homepage: https://fullcalendar.io/
- Size: 649 KB
- Stars: 16
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Fullcalendar Ruby Gem
This gem just includes [fullcalendar](https://fullcalendar.io/) and [scheduler](https://fullcalendar.io/scheduler/) as an asset in rails applications or other ruby frameworks
[Fullcaledar-scheduler](https://fullcalendar.io/scheduler/) is not free for commercial use, so make sure you have a valid [license](https://fullcalendar.io/scheduler/license/) to use scheduler.
## Installation
Fullcalendar JavaScript depends on jQuery and moment js. If you're using Rails 5.1+, add the jquery-rails gem to your Gemfile:
```ruby
gem 'jquery-rails'
gem 'momentjs-rails'
```
Add this line to your application's Gemfile:
```ruby
gem 'fullcalendar'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install fullcalendar
## Install generator
### command
```ruby
rails g fullcalendar:install
```
this generator will:
- 1. append ```//= require calendar ``` add `app/assets/javascripts/application.js`
- 2. append ```*= require calendar ``` add `app/assets/stylesheets/application.css`
- 3. create calendar.js in ```app/assets/javascripts/```
- 4. create calendar.scss in ```app/assets/stylesheets/```
## Manual install
### JavaScripts
Include the JavaScript in your `app/assets/javascripts/application.js`:
```
//= require jquery
//= require calendar
```
create new file `app/assets/javascripts/calendar.js`
```
//Core component
//= require fullcalendar
// optional locale
//= require fullcalendar/locale/ms
//Optional addon scheduler
//= require fullcalendar/scheduler
```
### Stylesheets
Include the stylesheet in your `app/assets/stylesheets/application.css`:
```
*= require calendar
```
or if you using scss
Include the stylesheet in your `app/assets/stylesheets/application.scss`:
```scss
@import 'calendar';
```
Create new file `app/assets/stylesheets/calendar.scss`
```scss
@import 'fullcalendar';
@import 'fullcalendar/scheduler';
```
### Initialization
Where needed in your JavaScripts, initialize your fullcalendar:
```js
$(document).ready(function() {
$("#calendar").fullCalendar();
});
```
## Usage
see fullcalendar documentations [here](https://fullcalendar.io/docs)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fullcalendar. 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.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Fullcalendar and Scheduler, which makes up the majority of this gem, has its own, separate licensing agreement.
- Fullcalendar [Read license](https://github.com/fullcalendar/fullcalendar/blob/master/LICENSE.txt)
- Scheduler [Read license](https://github.com/fullcalendar/fullcalendar-scheduler/blob/master/LICENSE.md)
## Code of Conduct
Everyone interacting in the Fullcalendar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fullcalendar/blob/master/CODE_OF_CONDUCT.md).