From 86dcde4e250bc881217b502ee3a322a4a7ab3be9 Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Thu, 6 Feb 2014 04:50:41 -0500 Subject: [PATCH 1/3] Updated Steam logo and API key instructions --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 85cc3aa32f..5399015805 100644 --- a/README.md +++ b/README.md @@ -195,10 +195,11 @@ Obtaining API Keys
- + - Go to http://steamcommunity.com/dev/apikey -- Once signed in, enter your domainm agree to terms, and click **Register** -- Copy and paste *key* into `config.secrets.js` +- Sign in with your existing Steam account +- Enter your *Domain Name*, then and click **Register** +- Copy and paste *Key* into `config.secrets.js` Project Structure ----------------- From 56cac693799240045fec8b11d60769ab32b5eb55 Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Thu, 6 Feb 2014 07:14:21 -0500 Subject: [PATCH 2/3] Add mongoose section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5399015805..2964599d1d 100644 --- a/README.md +++ b/README.md @@ -752,6 +752,10 @@ And that's it, we are done! If you want to see a really cool real-time dashboard check out this [live example](http://hackathonstarter.herokuapp.com/dashboard). Refer to the [pull request #23](https://github.com/sahat/hackathon-starter/pull/23/files) to see how it is implemented. +Mongoose Cheatsheet +------------------- +TODO + Deployment ---------- From bed77159b900d0ebe060268e687d9c111f3be798 Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Thu, 6 Feb 2014 07:21:47 -0500 Subject: [PATCH 3/3] Updated Project Structure table --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2964599d1d..8ac91fc694 100644 --- a/README.md +++ b/README.md @@ -213,18 +213,18 @@ Project Structure | **controllers**/home.js | Controller for home page (index). | | **controllers**/user.js | Controller for user account management page. | | **models**/User.js | Mongoose schema and model for User. | -| **public/*** | Static assets, i.e. fonts, css, js, img. | -| **public/css**/styles.less | Main stylesheet for your app. | +| **public/*** | Static assets (fonts, css, js, img) | +| **public/css**/styles.less | Main stylesheet for your app. | | **public/css/themes**/default.less | Some Bootstrap overrides to make it look prettier. | -| **views/account/*** | Templates relating to user account. | -| **views/api/*** | Templates relating to API Examples. | -| **views/partials**/flash.jade | Error, info and success notifications. | +| **views/account/*** | Templates for *login, signup, profile*. | +| **views/api/*** | Templates for API Examples. | +| **views/partials**/flash.jade | Error, info and success flash notifications. | | **views/partials**/navigation.jade | Navbar partial template. | | **views/partials**/footer.jade | Footer partial template. | | **views**/layout.jade | Base template. | | **views**/home.jade | Home page template. | | app.js | Main application file. | -| cluster_app.js | Creates multiple instances of `app.js` via Node.js clusters.| +| cluster_app.js | Creates multiple processes of `app.js` using Node.js clusters.| :exclamation: **Note:** There is no difference how you name or structure your views. You could place all your templates in a top-level `views` directory without having a nested folder structure, if that makes things easier for you. Just don't forget to update `extends ../layout` and corresponding `res.render()` method in controllers. For smaller apps, I find having a flat folder structure to be easier to work with.