mirror of
https://github.com/wassname/fullcalendar.git
synced 2026-07-12 00:50:41 +08:00
sean kenny
65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
#FORK INFO
|
|
This fork adds a vertical resource view to FullCalendar.
|
|
|
|
I'll be adding a link to plunkr with the forked version to demo its use.
|
|
|
|
FullCalendar - Full-sized drag & drop event calendar
|
|
====================================================
|
|
|
|
This document describes how to modify or contribute to the FullCalendar project.
|
|
If you are looking for end-developer documentation, please visit
|
|
the [project homepage](http://arshaw.com/fullcalendar/).
|
|
|
|
|
|
Getting Set Up
|
|
--------------
|
|
|
|
You will need [Git](http://git-scm.com/), [Node](http://nodejs.org/), and NPM installed.
|
|
For clarification, please view the
|
|
[jQuery readme](https://github.com/jquery/jquery/blob/master/README.md#what-you-need-to-build-your-own-jquery),
|
|
which requires a similar setup.
|
|
|
|
Also, you will need to have the [Grunt](http://gruntjs.com/) build system installed globally (`-g`) on your system:
|
|
|
|
npm install -g grunt-cli
|
|
|
|
Then, clone FullCalendar's git repo:
|
|
|
|
git clone git://github.com/arshaw/fullcalendar.git
|
|
|
|
Enter the directory and install FullCalendar's development dependencies:
|
|
|
|
cd fullcalendar && npm install
|
|
|
|
|
|
Development Workflow
|
|
--------------------
|
|
|
|
After you make code changes, you'll want to compile the JS/CSS so that it can be previewed from the tests and demos.
|
|
You can either manually rebuild each time you make a change:
|
|
|
|
grunt dev
|
|
|
|
Or, you can run a script that automatically rebuilds whenever you save a source file:
|
|
|
|
./build/watch
|
|
|
|
You can optionally add the `--sourceMap` flag to output source maps for debugging.
|
|
|
|
When you are finished, run the following command to write the distributable files into the `./build/out/`
|
|
and `./build/dist/` directories:
|
|
|
|
grunt
|
|
|
|
If you want to clean up the generated files, run:
|
|
|
|
grunt clean
|
|
|
|
|
|
Writing Tests
|
|
-------------
|
|
|
|
When fixing a bug or writing a feature, please make a corresponding HTML file in the `./tests/` directory
|
|
to visually demonstrate your work. If the test requires user intervention to prove its point, please write
|
|
instructions for the user to follow. Explore the existing tests for more info.
|