Commit 8651eb8e01ff5424d8d7eac184c7d050477caa29
1 parent
c8e69c4f02
Exists in
master
Add link to Changelog in README.md.
Showing
1 changed file
with
2 additions
and
0 deletions
Show diff stats
README.md
| 1 | # The Meteor Chef - Base (@0.9.3.1) | 1 | # The Meteor Chef - Base (@0.9.3.1) |
| 2 | A starting point for Meteor apps. | 2 | A starting point for Meteor apps. |
| 3 | 3 | ||
| 4 | Base is the lazy person's starter kit for Meteor. It includes some commonly used packages (biased to The Meteor Chef) and code for common functionality. This is the starter kit for all Meteor Chef recipes. | 4 | Base is the lazy person's starter kit for Meteor. It includes some commonly used packages (biased to The Meteor Chef) and code for common functionality. This is the starter kit for all Meteor Chef recipes. |
| 5 | 5 | ||
| 6 | For more detail on updates, [read the Changelog](https://github.com/themeteorchef/base/wiki/Changelog). | ||
| 7 | |||
| 6 | ### Packages Included | 8 | ### Packages Included |
| 7 | - Accounts (Base) - `meteor add accounts-base` | 9 | - Accounts (Base) - `meteor add accounts-base` |
| 8 | - Accounts (Password) - `meteor add accounts-password` | 10 | - Accounts (Password) - `meteor add accounts-password` |
| 9 | - Audit Argument Checks - `meteor add audit-argument-checks` | 11 | - Audit Argument Checks - `meteor add audit-argument-checks` |
| 10 | - Bootstrap 3 - `meteor add pinglamb:bootstrap3` | 12 | - Bootstrap 3 - `meteor add pinglamb:bootstrap3` |
| 11 | - Check - `meteor add check` | 13 | - Check - `meteor add check` |
| 12 | - CoffeeScript - `meteor add coffeescript` | 14 | - CoffeeScript - `meteor add coffeescript` |
| 13 | - Handlebars Server - `meteor add cmather:handlebars-server` | 15 | - Handlebars Server - `meteor add cmather:handlebars-server` |
| 14 | - Iron Router - `meteor add iron:router` | 16 | - Iron Router - `meteor add iron:router` |
| 15 | - jQuery - `meteor add jquery` | 17 | - jQuery - `meteor add jquery` |
| 16 | - jQuery Validation - `meteor add themeteorchef:jquery-validation` | 18 | - jQuery Validation - `meteor add themeteorchef:jquery-validation` |
| 17 | - Sass - `meteor add particle4dev:sass` | 19 | - Sass - `meteor add particle4dev:sass` |
| 18 | - Underscore - `meteor add underscore` | 20 | - Underscore - `meteor add underscore` |
| 19 | 21 | ||
| 20 | ### File Structure | 22 | ### File Structure |
| 21 | Base comes with a pre-defined file structure common to all projects along with some skeleton files for getting started quickly. Here's what it looks like: | 23 | Base comes with a pre-defined file structure common to all projects along with some skeleton files for getting started quickly. Here's what it looks like: |
| 22 | 24 | ||
| 23 | ``` | 25 | ``` |
| 24 | /root | 26 | /root |
| 25 | ---/.meteor | 27 | ---/.meteor |
| 26 | ---/client | 28 | ---/client |
| 27 | ------/controllers | 29 | ------/controllers |
| 28 | ---------/authenticated | 30 | ---------/authenticated |
| 29 | ------------header.coffee | 31 | ------------header.coffee |
| 30 | ---------/public | 32 | ---------/public |
| 31 | ------------login.coffee | 33 | ------------login.coffee |
| 32 | ------------signup.coffee | 34 | ------------signup.coffee |
| 33 | ------------recover-password.coffee | 35 | ------------recover-password.coffee |
| 34 | ------------reset-password.coffee | 36 | ------------reset-password.coffee |
| 35 | ------/helpers | 37 | ------/helpers |
| 36 | ---------helpers-ui.coffee | 38 | ---------helpers-ui.coffee |
| 37 | ------/includes | 39 | ------/includes |
| 38 | ---------_header.html | 40 | ---------_header.html |
| 39 | ------/layouts | 41 | ------/layouts |
| 40 | ---------layout-default.html | 42 | ---------layout-default.html |
| 41 | ------/routes | 43 | ------/routes |
| 42 | ---------filters.coffee | 44 | ---------filters.coffee |
| 43 | ---------routes-global.coffee | 45 | ---------routes-global.coffee |
| 44 | ---------routes-authenticated.coffee | 46 | ---------routes-authenticated.coffee |
| 45 | ---------routes-public.coffee | 47 | ---------routes-public.coffee |
| 46 | ------/stylesheets | 48 | ------/stylesheets |
| 47 | ---------/sass | 49 | ---------/sass |
| 48 | ------------/globals | 50 | ------------/globals |
| 49 | ---------------_extends.scss | 51 | ---------------_extends.scss |
| 50 | ------------/modules | 52 | ------------/modules |
| 51 | ------------/vendor | 53 | ------------/vendor |
| 52 | ------------/views | 54 | ------------/views |
| 53 | ---------------/authenticated | 55 | ---------------/authenticated |
| 54 | ---------------/public | 56 | ---------------/public |
| 55 | ------------------_login.scss | 57 | ------------------_login.scss |
| 56 | ---------application.scss | 58 | ---------application.scss |
| 57 | -------/views | 59 | -------/views |
| 58 | ---------/authenticated | 60 | ---------/authenticated |
| 59 | ------------index.html | 61 | ------------index.html |
| 60 | ---------/public | 62 | ---------/public |
| 61 | ------------login.html | 63 | ------------login.html |
| 62 | ------------not-found.html | 64 | ------------not-found.html |
| 63 | ------------recover-password.html | 65 | ------------recover-password.html |
| 64 | ------------reset-password.html | 66 | ------------reset-password.html |
| 65 | ------------signup.html | 67 | ------------signup.html |
| 66 | ---/collections | 68 | ---/collections |
| 67 | ------example.coffee | 69 | ------example.coffee |
| 68 | ---/lib | 70 | ---/lib |
| 69 | ---/packages | 71 | ---/packages |
| 70 | ------ (See List Above) | 72 | ------ (See List Above) |
| 71 | ---/public | 73 | ---/public |
| 72 | ---/server | 74 | ---/server |
| 73 | ------/admin | 75 | ------/admin |
| 74 | ---------accounts.coffee | 76 | ---------accounts.coffee |
| 75 | ---------startup.coffee | 77 | ---------startup.coffee |
| 76 | ------/data | 78 | ------/data |
| 77 | ---------/insert | 79 | ---------/insert |
| 78 | ---------/update | 80 | ---------/update |
| 79 | ---------/remove | 81 | ---------/remove |
| 80 | 82 | ||
| 81 | ---------/send | 83 | ---------/send |
| 82 | ---------/templates | 84 | ---------/templates |
| 83 | ------------reset-password.coffee | 85 | ------------reset-password.coffee |
| 84 | ------/publications | 86 | ------/publications |
| 85 | ``` | 87 | ``` |
| 86 | 88 | ||
| 87 | ### Language & Formatting | 89 | ### Language & Formatting |
| 88 | There are two considerations when using Base: JavaScript is written in [CoffeeScript](http://coffeescript.org) and CSS is written using [Sass](http://sass-lang.com). I prefer this setup because it allows me to move a little quicker than I do when writing in the native languages. This may not be for everybody, but I recommend giving both a shot because they make it much easier to write code. | 90 | There are two considerations when using Base: JavaScript is written in [CoffeeScript](http://coffeescript.org) and CSS is written using [Sass](http://sass-lang.com). I prefer this setup because it allows me to move a little quicker than I do when writing in the native languages. This may not be for everybody, but I recommend giving both a shot because they make it much easier to write code. |
| 89 | 91 | ||
| 90 | ### Functionality | 92 | ### Functionality |
| 91 | 93 | ||
| 92 | ###### Bootstrap (@3.2.0) | 94 | ###### Bootstrap (@3.2.0) |
| 93 | Base makes use of the [Bootstrap](http://getbootstrap.com) Front-End Framework. It may not be your bag of chips and is *definitely not required*. If you want to swap it out, you'll need to unhook the markup in each of the included template files in `/client/views` and uninstall the Bootstrap3 package by running `meteor remove pinglamb:bootstrap3` in your terminal. | 95 | Base makes use of the [Bootstrap](http://getbootstrap.com) Front-End Framework. It may not be your bag of chips and is *definitely not required*. If you want to swap it out, you'll need to unhook the markup in each of the included template files in `/client/views` and uninstall the Bootstrap3 package by running `meteor remove pinglamb:bootstrap3` in your terminal. |
| 94 | 96 | ||
| 95 | In respect to UI, Base uses Bootstrap's `.navbar` element, as well as its `.container` and a few `.row`/`.col-<size>-<columns>` wrappers. You'll also find the `.btn` class and its modifiers (`.success, .warning, etc.`) in use throughout the app. All of these applications are merely presentational and can be changed (or removed) as you see fit. | 97 | In respect to UI, Base uses Bootstrap's `.navbar` element, as well as its `.container` and a few `.row`/`.col-<size>-<columns>` wrappers. You'll also find the `.btn` class and its modifiers (`.success, .warning, etc.`) in use throughout the app. All of these applications are merely presentational and can be changed (or removed) as you see fit. |
| 96 | 98 | ||
| 97 | ###### Basic Routing | 99 | ###### Basic Routing |
| 98 | A collection of pre-defined routes and templates for common functionality (see Authenticate below). Also includes a set of common route filters for managing user access. Routes bundled include: | 100 | A collection of pre-defined routes and templates for common functionality (see Authenticate below). Also includes a set of common route filters for managing user access. Routes bundled include: |
| 99 | 101 | ||
| 100 | ``` | 102 | ``` |
| 101 | - / (Authenticated) | 103 | - / (Authenticated) |
| 102 | - /login (Public) | 104 | - /login (Public) |
| 103 | - /signup (Public) | 105 | - /signup (Public) |
| 104 | - /recover-password (Public) | 106 | - /recover-password (Public) |
| 105 | - /reset-password (Public) | 107 | - /reset-password (Public) |
| 106 | ``` | 108 | ``` |
| 107 | 109 | ||
| 108 | ###### Authentication | 110 | ###### Authentication |
| 109 | A complete authentication pattern complete with: | 111 | A complete authentication pattern complete with: |
| 110 | 112 | ||
| 111 | - Signup (at /signup) | 113 | - Signup (at /signup) |
| 112 | - Login (at /login) | 114 | - Login (at /login) |
| 113 | - Logout (no path, implemented as a dropdown item/click event in /client/controllers/header.coffee) | 115 | - Logout (no path, implemented as a dropdown item/click event in /client/controllers/header.coffee) |
| 114 | - Password Recovery (at /recover-password and /reset-password) | 116 | - Password Recovery (at /recover-password and /reset-password) |
| 115 | 117 | ||
| 116 | ###### Validation | 118 | ###### Validation |
| 117 | Validation via [jQuery Validation](http://jqueryvalidation.org). This applies to all of the public templates: login, signup, recover password, and reset password. | 119 | Validation via [jQuery Validation](http://jqueryvalidation.org). This applies to all of the public templates: login, signup, recover password, and reset password. |
| 118 | 120 | ||
| 119 | ###### Automatic Admin User Creation | 121 | ###### Automatic Admin User Creation |
| 120 | When developing, having a handful of user accounts to test your application with can come in handy. Base comes with an automated account generation script located in `server/admin/startup.coffee` that creates accounts based on an array of specified users. **Note: by default this creates one Admin user on server startup, so make sure to customize or remove this user so the public can't access your app**. | 122 | When developing, having a handful of user accounts to test your application with can come in handy. Base comes with an automated account generation script located in `server/admin/startup.coffee` that creates accounts based on an array of specified users. **Note: by default this creates one Admin user on server startup, so make sure to customize or remove this user so the public can't access your app**. |
| 121 | 123 |