Permalink
Browse files

updating developer setup and instructions

  • Loading branch information...
1 parent e8c4171 commit 07e6877031df6cd98140f8f3ce6884fec04ed2ec @cooperq cooperq committed Dec 5, 2013
Showing with 10 additions and 14 deletions.
  1. +8 −0 README.md
  2. +1 −1 package.json
  3. +0 −13 test/test-config.js
  4. +1 −0 test/test-config.js
View
@@ -13,6 +13,14 @@ Join the project or see it in action at http://www.ethersheet.org
4. edit config and put in the database name as well as the username and password
5. run npm start and navigate to localhost:8080
+#Developing
+1. Run the following command in your terminal:
+`curl https://raw.github.com/ethersheet-collective/EtherSheet/master/dev_install.sh | bash`
+3. copy examples/config-example.js to config.js in the EtherSheet directory
+4. edit config and put in the database name as well as the username and password
+5. run npm start and navigate to localhost:8080
+6. run the server tests with `npm test`
+7. run the client tests by navigating to http://localhost:8080/es_client/test/
#Dependencies
Ethersheet is only supported on linux and mysql as of right now, it's possible that it will work on windows or with postgres or some other database, but we haven't tested it on those platforms. If you want to submit a feature, send a pull request and we will look it over and accept it if it looks good.
View
@@ -8,7 +8,7 @@
"url": "https://github.com/ethersheet-collective/EtherSheet.git"
},
"engines": {
- "node": ">=0.6"
+ "nodejs": ">=0.6"
},
"dependencies": {
"express": "3.x",
View
@@ -1,13 +0,0 @@
-module.exports = {
- port: 8080,
- https_key: './examples/snakeoil.key',
- https_cert: './examples/snakeoil.crt',
- db_name: 'ethersheet',
- db_user: 'ethersheet',
- db_password: 'ethersheet',
- db_host: 'localhost',
- db_type: 'mysql',
- debug: false,
- default_row_count: 1,
- default_col_count: 1
-}
View

0 comments on commit 07e6877

Please sign in to comment.