Permalink
Browse files

Merge pull request #5 from eeezyy/master

Added installation instruction.
Changed demo link to a relative link.
Corrected some spelling mistakes.
  • Loading branch information...
2 parents 1cb4c84 + 0ec813d commit 1b7eefb305051fb0b2a92aaa28a3edcdf1bef29b @eeezyy eeezyy committed Nov 14, 2011
Showing with 77 additions and 11 deletions.
  1. +26 −3 .gitignore
  2. +33 −5 README.md
  3. +1 −1 app.js
  4. +15 −0 package.json
  5. +2 −2 views/home.jade
View
29 .gitignore
@@ -1,5 +1,28 @@
-.DS_Store
+## generic files to ignore
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+*~
+*.lock
+*.DS_Store
*.swp
+*.out
-# Folders
-uploads
+pids
+logs
+results
+
+node_modules
+npm-debug.log
+
+tmp/*
+log/*
+.livereload
+.monitor
+
+uploads/*
View
38 README.md
@@ -1,6 +1,6 @@
![sharedesk logo](http://sharedesk.at/images/logo.png)
-what is ShareDesk?
+What is ShareDesk?
-------------
[ShareDesk](http://sharedesk.at) is a web based file sharing tool build on
node.js, websockets(socket.io), HTML5/CSS3, jQuery.
@@ -30,14 +30,42 @@ of your project (set a password if you want) and start dragging files :)
or you use it on your own server, below are some instruction how to install it.
-installation
+Installation
------------
-coming...
+1. node.js
+You can find the installation instruction for you system at the github wiki of nodejs (https://github.com/joyent/node/wiki/Installation).
+Sharedesk will not work on Windows systems.
-licence
+2. NPM
+To install the node modules used in sharedesk, you need the node package manager (NPM). The installation instruction can be find at the npm github page (https://github.com/isaacs/npm).
+
+3. MongoDB
+Sharedesk uses mongoDB as the database. It can also be installed on different systems. The instruction are on the mongoDB website (http://www.mongodb.org/display/DOCS/Quickstart).
+
+4. shareDesk
+As we have installed the runtime environment we can proceed with shareDesk.
+There are two ways to get shareDesk:
+* Download the archive file (zip) and extract it to your directory (https://github.com/namjul/shareDesk/zipball/master).
+* Get shareDesk by cloning it with git: `git clone git://github.com/eeezyy/shareDesk.git`
+
+5. Modules
+
+Go to your shareDesk folder in the console and run the following command:
+`npm install`
+
+Run the server
+------------
+Start the mongoDB deamon: `mongod &`
+
+Start shareDesk in the shareDesk directory: node app.js
+To start shareDesk on a different port then 80, just append the port: node app.js 8080
+
+On linux systems you can assure that shareDesk runs even if you are logged out from your system by prepending the command `nohup`: `nohup node app.js`
+
+Licence
------------
ShareDesk — A web based file sharing tool.
-Copyright (C) 2011 Samuel Hobl, Alexander Kumbeiz, Goran Janosevicz
+Copyright (C) 2011 Samuel Hobl, Alexander Kumbeiz, Goran Janosevic
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
View
2 app.js
@@ -426,7 +426,7 @@ app.post('/:deskname/login', function(req, res) {
if(passwordHash != desk.protection.passwordHash) {
resObject.state = 0;
- resObject.message = 'You entern a wrong password';
+ resObject.message = 'You have entered a wrong password';
res.send(resObject);
} else {
View
15 package.json
@@ -0,0 +1,15 @@
+{
+ "name": "sharedesk.at",
+ "description": "A starting boilerplate for node.js Apps in MVC",
+ "version": "0.0.1",
+ "engine": "node 0.4.1",
+ "main": "app.js",
+ "dependencies": {
+ "express": ">= 2.2.2",
+ "connect": ">= 1.4.2",
+ "connect-mongodb": ">= 1.1.1",
+ "formidable": ">= 1.0.7",
+ "jade": ">= 0.17.0",
+ "socket.io": ">= 0.8.7"
+ }
+}
View
4 views/home.jade
@@ -33,9 +33,9 @@ html(lang="en")
br
br
br
- p Example Desktop <a href="http://sharedesk.at/demo">http://sharedesk.at/demo</a>
+ p Example Desktop <a href="demo">http://sharedesk.at/demo</a>
div.info
- p ShareDesk was build by 3 students <br> from <a href="http://www.technikum-wien.at/">Technikum Wien</a> <br> during sommer semester 2011 <br><br> Samuel Hobl <br> Alexander Kumbeiz <br> Goran Janosevizc
+ p ShareDesk was build by 3 students <br> from <a href="http://www.technikum-wien.at/">Technikum Wien</a> <br> during sommer semester 2011 <br><br> Samuel Hobl <br> Alexander Kumbeiz <br> Goran Janosevic
br
br
br

0 comments on commit 1b7eefb

Please sign in to comment.