gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated project structure table

Browse Source
This commit is contained in:
Sahat Yalkabov
2014-04-14 21:04:48 -04:00
parent 273d902e8d
commit f39bfcf3dd
1 changed files with 23 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -64,7 +64,7 @@ Features
- **Local Authentication** using Email and Password - **Local Authentication** using Email and Password
- **OAuth 1.0a Authentication** via Twitter - **OAuth 1.0a Authentication** via Twitter
- **OAuth 2.0 Authentication** via Facebook, Google, GitHub, LinkedIn or Instagram - **OAuth 2.0 Authentication** via Facebook, Google, GitHub, LinkedIn, Instagram
- Flash notifications with animations by [animate.css](http://daneden.github.io/animate.css/) - Flash notifications with animations by [animate.css](http://daneden.github.io/animate.css/)
- MVC Project Structure - MVC Project Structure
- Node.js [clusters](http://nodejs.org/api/cluster.html#cluster_cluster) support - Node.js [clusters](http://nodejs.org/api/cluster.html#cluster_cluster) support
@ -278,31 +278,36 @@ The same goes for other providers.
Project Structure Project Structure
----------------- -----------------
| Name | Description | | Name | Description |
| ------------- |:-------------:| | ---------------------------------- |:-----------------------------------------------------------:|
| **config**/passport.js | Passport Local and OAuth strategies + Passport middleware. | | **config**/passport.js | Passport Local and OAuth strategies, plus login middleware. |
| **config**/secrets.js | Your API keys, tokens, passwords and database URL. | | **config**/secrets.js | Your API keys, tokens, passwords and database URL. |
| **controllers**/api.js | Controller for /api route and all api examples. | | **controllers**/api.js | Controller for /api route and all api examples. |
| **controllers**/contact.js | Controller for contact form. | | **controllers**/contact.js | Controller for contact form. |
| **controllers**/home.js | Controller for home page (index). | | **controllers**/home.js | Controller for home page (index). |
| **controllers**/user.js | Controller for user account management. | | **controllers**/user.js | Controller for user account management. |
| **models**/User.js | Mongoose schema and model for User. | | **models**/User.js | Mongoose schema and model for User. |
| **public/*** | Static assets (fonts, css, js, img) | | **public**/ | Static assets (fonts, css, js, img). |
| **public/js/**application.js | Declare which JavaScript files should be loaded, e.g. *jQuery*, *Bootstrap*, *main.js*. | | **public**/**js**/application.js | Specify client-side JavaScript dependencies. |
| **public/js/**main.js | Place your client-side JavaScript here. | | **public**/**js**/main.js | Place your client-side JavaScript here. |
| **public/css/**styles.less | Main stylesheet for your app. | | **public**/**css**/styles.less | Main stylesheet for your app. |
| **public/css/themes**/default.less | Some Bootstrap overrides to make it look prettier. | | **public/css/themes**/default.less | Some Bootstrap overrides to make it look prettier. |
| **views/account/** | Templates for *login, password reset, signup, profile*. | | **views/account**/ | Templates for *login, password reset, signup, profile*. |
| **views/api/** | Templates for API Examples. | | **views/api**/ | Templates for API Examples. |
| **views/partials**/flash.jade | Error, info and success flash notifications. | | **views/partials**/flash.jade | Error, info and success flash notifications. |
| **views/partials**/navigation.jade | Navbar partial template. | | **views/partials**/navigation.jade | Navbar partial template. |
| **views/partials**/footer.jade | Footer partial template. | | **views/partials**/footer.jade | Footer partial template. |
| **views**/layout.jade | Base template. | | **views**/layout.jade | Base template. |
| **views**/home.jade | Home page template. | | **views**/home.jade | Home page template. |
| app.js | Main application file. | | app.js | Main application file. |
| cluster_app.js | Runs multiple instances of `app.js` using <a href="http://nodejs.org/api/cluster.html" target="_blank">Node.js clusters</a>.| | cluster_app.js | Runs multiple instances of `app.js` Node.js clusters. |
| generator.js | Tool for adding/removing authentications and other things. |
:exclamation: **Note:** There is no preference 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. :exclamation: **Note:** There is no preference 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()` paths in controllers.
List of Packages List of Packages
---------------- ----------------