mirror of
https://github.com/wassname/fullcalendar.git
synced 2026-08-20 12:20:17 +08:00
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
|
|
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
|
|
|
|
|
|
Building
|
|
--------
|
|
|
|
To build a concatenated, minified version of FullCalendar in the ./build/out/fullcalendar/ directory, run:
|
|
|
|
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. |