mirror of
https://github.com/coderaiser/cloudcmd.git
synced 2026-01-23 18:55:26 +00:00
v0.1.8
This commit is contained in:
coderaiser
parent
153f1073d4
commit
b081e63fa7
1 changed files with 196 additions and 0 deletions
196
README.md
Normal file
196
README.md
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
Cloud Commander [](http://travis-ci.org/coderaiser/cloudcmd)
|
||||
===============
|
||||
**Cloud Commander** - user friendly cloud file manager.
|
||||
DEMO:
|
||||
[cloudfoundry] (http://cloudcmd.cloudfoundry.com "cloudfoundry"),
|
||||
[appfog] (http://cloudcmd.aws.af.cm "appfog").
|
||||
|
||||
Google PageSpeed Score : [100](https://developers.google.com/speed/pagespeed/insights#url=http_3A_2F_2Fcloudcmd.cloudfoundry.com_2F&mobile=false "score") (out of 100)
|
||||
(or 96 if js or css minification disabled in config.json).
|
||||
|
||||
|
||||
|
||||
Benefits
|
||||
---------------
|
||||
- full browser compatibility *(ie6+,chrome,safari,opera,firefox)*;
|
||||
- responsible design
|
||||
- one full page loading, *and then just one-time json-dir-listings loading
|
||||
(with refresh opportunity).*
|
||||
- caching readed directories *to localStorage (for now)
|
||||
(so if network will disconnected or something heppen with a signal, we
|
||||
definitely will can work with cached copy of directory listings)*;
|
||||
- key binding
|
||||
- disabled js support *(working in limited mode)*.
|
||||
- automated minification *client js-files and onstart-reading Cloud manager files on server starting.*
|
||||
|
||||
**Cloud Commander** uses all benefits of js, so if js is disabled,
|
||||
we moves to *limited mode*.
|
||||
|
||||
Limited-mode features
|
||||
---------------
|
||||
- no keybinding
|
||||
- no local caching
|
||||
- full loading of all web page(with styles, js-scripts, html-page etc).
|
||||
|
||||
Hot keys
|
||||
---------------
|
||||
In all modern web browsers (but not in IE, becouse he special) hot keys works.
|
||||
There is a short list:
|
||||
- **Ctrl + r** - reload dir content
|
||||
- **Ctrl + d** - clear local cache (wich contains dir contents)
|
||||
- **Alt + q** - disable key bindings
|
||||
- **Alt + s** - get all key bindings back
|
||||
- **up, down, enter** - filesystem navigation
|
||||
- **Alt + g** - authorization
|
||||
|
||||
Viewer's hot keys
|
||||
---------------
|
||||
- **Shift + F3** - open viewer window
|
||||
- **Esc** - close viewer window
|
||||
|
||||
Editor's hot keys
|
||||
---------------
|
||||
- **F3** - open CodeMirror editor in read only mode
|
||||
- **F4** - open CodeMirror editor
|
||||
- **Esc** - close CodeMirror editor
|
||||
|
||||
Documentation
|
||||
---------------
|
||||
JS Doc documentation could be found in [http://jsdoc.info/coderaiser/cloudcmd/](http://jsdoc.info/coderaiser/cloudcmd/)
|
||||
|
||||
Installing
|
||||
---------------
|
||||
**Cloud Commander** installing is very easy. All you need it's just clone
|
||||
repository from github. Just 2 commands:
|
||||
|
||||
git clone git://github.com/coderaiser/cloudcmd.git
|
||||
cd cloudcmd
|
||||
or
|
||||
|
||||
npm i cloudcmd
|
||||
mv node_modules/cloudcmd ./
|
||||
|
||||
Configuration
|
||||
---------------
|
||||
All main configuration could be done thrue config.json.
|
||||
```js
|
||||
{
|
||||
"api_url" :"/api/v1",
|
||||
"appcache" : false, /* html5 feature appcache */
|
||||
"cache" : {"allowed" : true}, /* cashing of js and css files in memory */
|
||||
"minification" : { /* minification of js,css,html and img */
|
||||
"js" : false, /* minify module neaded */
|
||||
"css" : false, /* npm i minify */
|
||||
"html" : true,
|
||||
"img" : false
|
||||
},
|
||||
"github_key" : "891c251b925e4e967fa9",
|
||||
"github_secret" : "afe9bed1e810c5dc44c4c2a953fc6efb1e5b0545",
|
||||
"dropbox_key" : "0nd3ssnp5fp7tqs",
|
||||
"dropbox_chooser_key" : "o7d6llji052vijk"
|
||||
"show_keys_panel" : true, /* show classic panel with buttons of keys */
|
||||
"server" : true, /* server mode or testing mode */
|
||||
"logs" : false, /* logs or console ouput */
|
||||
"socket" : true /* enable web sockets */
|
||||
"port" : 80, /* Cloud Commander port */
|
||||
"ip" : "127.0.0.1", /* Cloud Commander IP */
|
||||
"rest" : true /* enable rest interface */
|
||||
}
|
||||
```
|
||||
Authorization
|
||||
---------------
|
||||
Thru openID Cloud Commander could authorize clients on GitHub.
|
||||
All things that should be done is must be added **id** and **secret** of application
|
||||
from github settings page and added to **config.json** (id just) and env varible (secret)
|
||||
with names: *github_id*, *github_secret*, *dropbox_key*, *dropbox_secret* etc.
|
||||
For more information see **config.json** and **shell/seret.bat** *(on win32)*
|
||||
or **shell/secret.sh** *(on nix)*.
|
||||
|
||||
|
||||
Starting
|
||||
---------------
|
||||
To start **Cloud Commander** only one command neaded:
|
||||
|
||||
node cloudcmd
|
||||
or on win platform just
|
||||
|
||||
cloudcmd
|
||||
After thet Cloud Commander reads config file **config.json** and start server
|
||||
on 80 port, if none of port varibles(*cloud9*, *cloudfoundry* and *nodester*)
|
||||
isn't exist.
|
||||
Then type in browser
|
||||
|
||||
http://127.0.0.1
|
||||
or
|
||||
|
||||
http://localhost
|
||||
Updating
|
||||
---------------
|
||||
**Cloud Commander** is very alfa and it's very often updatings.
|
||||
Update is doing automagically but it could be done also manualy
|
||||
by typing a few commands in cloudcmd directory:
|
||||
|
||||
git pull
|
||||
or check new version on npm
|
||||
|
||||
npm info cloudcmd
|
||||
|
||||
and then, if there is new version
|
||||
|
||||
npm r cloudcmd
|
||||
npm i cloudcmd
|
||||
|
||||
Additional modules
|
||||
---------------
|
||||
**Cloud Commander's Server Side** not using additional modules for main functionality.
|
||||
But for minification and optimization tricks optional can be
|
||||
assingned (and installed) modules: [Minify] (https://github.com/coderaiser/minify "Minify")
|
||||
and [socket.io] (https://github.com/LearnBoost/socket.io "Socket.IO").
|
||||
|
||||
Install addtitional modules:
|
||||
|
||||
npm i
|
||||
|
||||
**Cloud Commander's Client Side** use module jquery for ajaxing. But only for old browsers.
|
||||
We could not use this module, but this way is fast:
|
||||
- google cdn
|
||||
- gzip
|
||||
- cache
|
||||
|
||||
Perhaps in the future, it will not be used, but so far it has no effect on
|
||||
start loading of Cloud Commander Client Side and do things fast and stable
|
||||
it is using now.
|
||||
|
||||
Extensions
|
||||
---------------
|
||||
**Cloud Commander** desinged to easily porting extensions.
|
||||
For extend main functionality Cloud Commander use next modules:
|
||||
- [CodeMirror] [CodeMirrorURL]
|
||||
- [FancyBox] [FancyBoxURL]
|
||||
- [jQuery-contextMenu] [jQuery-contextMenuURL]
|
||||
- [jquery.terminal] [jquery.terminalURL]
|
||||
|
||||
[CodeMirrorURL]: https://github.com/marijnh/CodeMirror "CodeMirror"
|
||||
[FancyBoxURL]: https://github.com/fancyapps/fancyBox "FancyBox"
|
||||
[jQuery-contextMenuURL]: https://github.com/medialize/jQuery-contextMenu "jQuery-contextMenu"
|
||||
[jquery.terminalURL]: https://github.com/jcubic/jquery.terminal "jquery.terminal"
|
||||
|
||||
Contributing
|
||||
---------------
|
||||
If you would like to contribute - send pull request to dev branch.
|
||||
Getting dev version of **Cloud Commander**:
|
||||
|
||||
git clone git://github.com/coderaiser/cloudcmd.git
|
||||
git checkout dev
|
||||
|
||||
It is possible thet dev version Cloud Commander will needed dev version of Minify,
|
||||
so to get it you should type a couple more commands:
|
||||
|
||||
cd node_modules
|
||||
rm -rf minify
|
||||
git clone git://github.com/coderaiser/minify
|
||||
git checkout dev
|
||||
|
||||
Special Thanks
|
||||
---------------
|
||||
[Elena Zalitok](http://vk.com/politilena "Elena Zalitok") for logo.
|
||||
Loading…
Add table
Add a link
Reference in a new issue