Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 128 lines (102 sloc) 4.132 kb
3ae5505 added readme and license
unknown authored
1 Fiddle Salad Live Web Development
2 ======================
16de6a4 @yuguang change project description
authored
3 The web developer's wonderland that makes everyday tasks enjoyable, a live editor for front-end languages
3ae5505 added readme and license
unknown authored
4 #### [fiddlesalad.com](http://fiddlesalad.com)
5
2506d3d @yuguang add features to be completed in the short-term
authored
6 Current Features
7 ----------------
8 * Views
9 * Results (live)
10 * Compiled output (live)
11 * CSS tooltips
12 * jQuery API links
13 * Auto-complete
14 * CSS keyword
15 * HTML attributes
16 * JavaScript context
17 * Saving
18 * Local history
c2aba41 @yuguang change project description
authored
19 * Diff of different revisions
9a15aab @yuguang search js packages on cdnjs
authored
20 * Converters
21 * JS -> CoffeeScript
22 * HTML -> Jade
140f63e @yuguang update readme with more instructions
authored
23 * HTML -> HAML
24 * CSS -> SASS
25 * CSS -> SCSS
2506d3d @yuguang add features to be completed in the short-term
authored
26 * Import from existing site
27
3ae5505 added readme and license
unknown authored
28 Supported Languages
2506d3d @yuguang add features to be completed in the short-term
authored
29 -------------------
3ae5505 added readme and license
unknown authored
30
31 * HTML
32 * HAML
33 * Zen Coding (input method)
34 * Jade
2506d3d @yuguang add features to be completed in the short-term
authored
35 * CoffeeCup
58edd04 @yuguang update todo list
authored
36 * Markdown
3ae5505 added readme and license
unknown authored
37
38 * CSS
39 * SASS and SCSS with Compass
40 * LESS
41 * Stylus
42
43 * JavaScript
44 * CoffeeeScript
45 * Python
58edd04 @yuguang update todo list
authored
46 * Roy
3ae5505 added readme and license
unknown authored
47
48 Getting the Code and Running it
49 -------------------------------
50
51 git clone git://github.com/yuguang/fiddlesalad.git
0c7a2f3 @yuguang update setup links
authored
52 git clone git://github.com/yuguang/cloud-ide-templates.git
53 mv cloud-ide-templates templates
54 git clone git://github.com/yuguang/django-cloud-ide.git
55 cd django-cloud-ide
3ae5505 added readme and license
unknown authored
56 python setup.py install
57 cd ../fiddlesalad
58 mv settings.default.py settings.py
76389a1 @yuguang Update README.md
authored
59 pip install -r requirements.txt (see http://guide.python-distribute.org/installation.html if you don't have pip)
059c0d9 @yuguang make installation easier
authored
60 python manage.py syncdb
3ae5505 added readme and license
unknown authored
61 python manage.py runserver
62
c2aba41 @yuguang change project description
authored
63 Open http://127.0.0.1:8000/ in the browser.
3ae5505 added readme and license
unknown authored
64
3f631fe @yuguang fix issues with installation
authored
65 Installation Notes
66 ------------------
67 ###Compiling CoffeeScript
31efd63 @yuguang add coffeecup language option
authored
68 from the _static/js/_ folder run
3f631fe @yuguang fix issues with installation
authored
69
31efd63 @yuguang add coffeecup language option
authored
70 coffee -cw -o ./compiled-coffee .\
140f63e @yuguang update readme with more instructions
authored
71
72 ###Compiling Less
73 run [less compiler](http://lesscss.org/#-server-side-usage) from the command line or install [SimpLESS](http://wearekiss.com/simpless)
74
3f631fe @yuguang fix issues with installation
authored
75
2506d3d @yuguang add features to be completed in the short-term
authored
76 Developer Documentation
77 -----------------------
3ae5505 added readme and license
unknown authored
78
140f63e @yuguang update readme with more instructions
authored
79 The [wiki](https://github.com/yuguang/fiddlesalad/wiki) has information on the overall design
231ff87 @yuguang fix sentence in readme
authored
80 as well as UML diagrams.
140f63e @yuguang update readme with more instructions
authored
81
3ae5505 added readme and license
unknown authored
82
2506d3d @yuguang add features to be completed in the short-term
authored
83 Contribution Guidelines
c04187b @yuguang add coffeecup editor
authored
84 -----------------------
85
2506d3d @yuguang add features to be completed in the short-term
authored
86 Features ready to be implemented:
87
88 * HTML class and id auto-complete
642eb67 @yuguang remove unused index files from codemirror dist
authored
89 * Auto-semicolon insertion for CSS style languages
90 * Hide window title bar option
cea9389 @yuguang add task to todo list
authored
91 * Color picker when hovering over CSS color values in editor
92 * Homepage with vertical orientation and categorized languages
642eb67 @yuguang remove unused index files from codemirror dist
authored
93 * Scroll source to current cursor position in editor
94 * Better CoffeeCup documentation page with syntax highlighting
95 * Use CodeMirror's built-in run mode
96 * More Languages
140f63e @yuguang update readme with more instructions
authored
97 * [Eco](https://github.com/sstephenson/eco) ([Browserify](https://github.com/substack/node-browserify) nodejs module)
98 * [Traceur](http://code.google.com/p/traceur-compiler/)
99 * [Move](https://github.com/rsms/move)
2506d3d @yuguang add features to be completed in the short-term
authored
100
101 ###Syntax Highlighting
642eb67 @yuguang remove unused index files from codemirror dist
authored
102 Get started by reading the [CodeMirror manual](http://codemirror.net/doc/manual.html#modeapi). The modes are under _static/js/codemirror/mode/_.
2506d3d @yuguang add features to be completed in the short-term
authored
103
140f63e @yuguang update readme with more instructions
authored
104 ###Language Editor
105 To add a language:
106
107 1. Modify the LANGUAGE and LANGUAGE_CATEGORY settings in *fiddle-configuration.js*.
108 2. Write a class in *fiddle-engine.coffee* that inherits *(Style/Program/Document)Editor*
b5d2a82 @yuguang remove unindented code in readme
authored
109 3. Create the compiler (aka worker) in _static/js/compilers/_ with the [sendResult and sendError functions](https://github.com/yuguang/fiddlesalad/blob/master/static/js/compilers/coffeescript.js).
110 The compiler reads input from e.data for style and program editors and e.data.code for document editors
140f63e @yuguang update readme with more instructions
authored
111
112 ###User Interface
113 ####Home
114 The Homepage uses [Twitter Bootstrap's fluid grid system](http://twitter.github.com/bootstrap/scaffolding.html#fluidGridSystem)
115 to align buttons. The main files to modify are *templates/home.html* and *static/css/home.less*.
116
117 ####Fiddle
118 All UI elements are generated using [Knockout](http://knockoutjs.com/documentation/introduction.html)
119 and [jQuery UI](http://jqueryui.com/demos/). Knockout templates are in *templates/templates.html*, with the View Model
120 in *static/js/model.coffee*. Main stylesheet is *static/css/fiddle.less*.
121
2506d3d @yuguang add features to be completed in the short-term
authored
122 Contributors
123 ------------
124
125 Thanks to
126
127 * [Tom Wilson](https://github.com/twilson63) for the CoffeeCup compiler
128 * [Lorin Tackett](https://github.com/ltackett) for home page redesign (in progress)
Something went wrong with that request. Please try again.