Commit 07610a42f3d1bc83ec5dcc5395b3f79514c110bb

Authored by Ryan Glover
1 parent 510619f55a
Exists in master

Update README to reflect correct file structure, packages,

and current Meteor version. Change name of Not Found template to
use a hyphen instead of camel case.
1 # The Meteor Chef - Base 1 # The Meteor Chef - Base (@0.9.2.2)
2 A starting point for Meteor apps. 2 A starting point for Meteor apps.
3 3
4 ### **This project is currently under heavy development and not recommended for use.** 4 ### **This project is currently under heavy development and not recommended for use.**
5 5
6 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. 6 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.
7 7
8 ### Packages Included 8 ### Packages Included
9 - Accounts (Base) - `meteor add accounts-base` 9 - Accounts (Base) - `meteor add accounts-base`
10 - Accounts (Password) - `meteor add accounts-password` 10 - Accounts (Password) - `meteor add accounts-password`
11 - Audit Argument Checks - `meteor add audit-argument-checks` 11 - Audit Argument Checks - `meteor add audit-argument-checks`
12 - Bootstrap 3 - `mrt add bootstrap-3` 12 - Bootstrap 3 - `meteor add pinglamb:bootstrap3`
13 - Check - `meteor add check` 13 - Check - `meteor add check`
14 - CoffeeScript - `meteor add coffeescript` 14 - CoffeeScript - `meteor add coffeescript`
15 - Handlebars Server - `mrt add handlebars-server` 15 - Handlebars Server - `meteor add cmather:handlebars-server`
16 - Iron Router - `mrt add iron-router` 16 - Iron Router - `meteor add iron:router`
17 - jQuery - `meteor add jquery` 17 - jQuery - `meteor add jquery`
18 - Sass - `mrt add sass` 18 - Sass - `meteor add particle4dev:sass`
19 - Underscore - `meteor add underscore` 19 - Underscore - `meteor add underscore`
20 20
21 ### File Structure 21 ### File Structure
22 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 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 23
24 ``` 24 ```
25 /root 25 /root
26 ---/.meteor
26 ---/client 27 ---/client
27 ------/controllers 28 ------/controllers
28 ---------/public 29 ---------/public
29 ------------login.coffee 30 ------------login.coffee
30 ------------signup.coffee 31 ------------signup.coffee
31 ------------recover-password.coffee 32 ------------recover-password.coffee
32 ------------reset-password.coffee 33 ------------reset-password.coffee
33 ------/helpers 34 ------/helpers
34 ---------helpers-ui.coffee 35 ---------helpers-ui.coffee
35 ------/layouts 36 ------/layouts
36 ---------layout-default.html 37 ---------layout-default.html
37 ------/routes 38 ------/routes
38 ---------filters.coffee 39 ---------filters.coffee
39 ---------routes-global.coffee 40 ---------routes-global.coffee
40 ---------routes-authenticated.coffee 41 ---------routes-authenticated.coffee
41 ---------routes-public.coffee 42 ---------routes-public.coffee
42 ------/stylesheets 43 ------/stylesheets
43 ---------/globals 44 ---------/sass
44 ------------_extends.scss 45 ------------/globals
45 ---------/modules 46 ---------------_extends.scss
46 ---------/vendor 47 ------------/modules
47 ---------/views 48 ------------/vendor
48 ------------/public 49 ------------/views
49 ---------------_login.scss 50 ---------------/authenticated
50 ---------app.scss 51 ---------------/public
52 ------------------_login.scss
53 ---------application.scss
51 -------/views 54 -------/views
52 ---------/authenticated 55 ---------/authenticated
53 ------------index.html 56 ------------index.html
54 ---------/public 57 ---------/public
55 ------------login.html 58 ------------login.html
59 ------------not-found.html
56 ------------recover-password.html 60 ------------recover-password.html
57 ------------reset-password.html 61 ------------reset-password.html
58 ------------signup.html 62 ------------signup.html
59 ---/collections 63 ---/collections
60 ------example.coffee 64 ------example.coffee
61 ---/lib 65 ---/lib
62 ---/packages 66 ---/packages
63 ------ (See List Above) 67 ------ (See List Above)
64 ---/public 68 ---/public
65 ---/server 69 ---/server
66 ------/admin 70 ------/admin
67 ---------accounts.coffee 71 ---------accounts.coffee
68 ---------startup.coffee 72 ---------startup.coffee
69 ------/publications
70 ------/email
71 ---------/send
72 ---------/templates
73 ------/data 73 ------/data
74 ---------/insert 74 ---------/insert
75 ---------/update 75 ---------/update
76 ---------/remove 76 ---------/remove
77 ------/email
78 ---------/send
79 ---------/templates
80 ------/publications
77 ``` 81 ```
78 82
79 ### Language & Formatting 83 ### Language & Formatting
80 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. 84 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.
81 85
82 ### Functionality 86 ### Functionality
83 87
84 ###### Basic Routing 88 ###### Basic Routing
85 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: 89 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:
86 90
87 ``` 91 ```
88 - / (Authenticated) 92 - / (Authenticated)
89 - /login (Public) 93 - /login (Public)
90 - /signup (Public) 94 - /signup (Public)
91 - /recover-password (Public) 95 - /recover-password (Public)
92 - /reset-password (Public) 96 - /reset-password (Public)
93 ``` 97 ```
94 98
95 ###### Authentication (Not Included Yet, Just Documenting) 99 ###### Authentication (Not Included Yet, Just Documenting)
96 A complete authentication pattern complete with: 100 A complete authentication pattern complete with:
97 101
98 - Signup (at /signup) 102 - Signup (at /signup)
99 - Login (at /login) 103 - Login (at /login)
100 - Password Recovery (at /recover-password and /reset-password) 104 - Password Recovery (at /recover-password and /reset-password)
client/views/public/not-found.html
File was created 1 <template name="notFound">
2 <h1>404 &mdash; Not Found.</h1>
3 </template>
4
client/views/public/notFound.html
1 <template name="notFound"> File was deleted
2 <h1>404 &mdash; Not Found.</h1>
3 </template>
4 1 <template name="notFound">