Sunny Negi / Meteor-projects

Download as
Browse Code ยป

Commit e4dcfed4057d70fe8d7f505b93207c0dc8510bdf

Authored by Ryan Glover
1 parent ad452967b6
Exists in master

Add note about development state.

Showing 1 changed file with 2 additions and 0 deletions   Show diff stats
1 # The Meteor Chef - Base 1 # The Meteor Chef - Base
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.**
5
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. 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.
5 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 - `mrt add bootstrap-3` 12 - Bootstrap 3 - `mrt add bootstrap-3`
11 - Check - `meteor add check` 13 - Check - `meteor add check`
12 - CoffeeScript - `meteor add coffeescript` 14 - CoffeeScript - `meteor add coffeescript`
13 - Handlebars Server - `mrt add handlebars-server` 15 - Handlebars Server - `mrt add handlebars-server`
14 - Iron Router - `mrt add iron-router` 16 - Iron Router - `mrt add iron-router`
15 - jQuery - `meteor add jquery` 17 - jQuery - `meteor add jquery`
16 - Sass - `mrt add sass` 18 - Sass - `mrt add sass`
17 - Underscore - `meteor add underscore` 19 - Underscore - `meteor add underscore`
18 20
19 ### File Structure 21 ### File Structure
20 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:
21 23
22 ``` 24 ```
23 /root 25 /root
24 ---/client 26 ---/client
25 ------/controllers 27 ------/controllers
26 ---------/public 28 ---------/public
27 ------------login.coffee 29 ------------login.coffee
28 ------------signup.coffee 30 ------------signup.coffee
29 ------------recover-password.coffee 31 ------------recover-password.coffee
30 ------------reset-password.coffee 32 ------------reset-password.coffee
31 ------/helpers 33 ------/helpers
32 ---------helpers-ui.coffee 34 ---------helpers-ui.coffee
33 ------/layouts 35 ------/layouts
34 ---------layout-default.html 36 ---------layout-default.html
35 ------/routes 37 ------/routes
36 ---------filters.coffee 38 ---------filters.coffee
37 ---------routes-global.coffee 39 ---------routes-global.coffee
38 ---------routes-authenticated.coffee 40 ---------routes-authenticated.coffee
39 ---------routes-public.coffee 41 ---------routes-public.coffee
40 ------/stylesheets 42 ------/stylesheets
41 ---------/globals 43 ---------/globals
42 ---------/modules 44 ---------/modules
43 ---------/vendor 45 ---------/vendor
44 ---------/views 46 ---------/views
45 ------------/public 47 ------------/public
46 ---------------login.html 48 ---------------login.html
47 ---------------recover-password.html 49 ---------------recover-password.html
48 ---------------reset-password.html 50 ---------------reset-password.html
49 ---------------signup.html 51 ---------------signup.html
50 ---------app.scss 52 ---------app.scss
51 ------/views 53 ------/views
52 ---------/example 54 ---------/example
53 ------------example.html 55 ------------example.html
54 ---/collections 56 ---/collections
55 ------example.coffee 57 ------example.coffee
56 ---/lib 58 ---/lib
57 ---/packages 59 ---/packages
58 ---/public 60 ---/public
59 ---/server 61 ---/server
60 ------/admin 62 ------/admin
61 ---------startup.coffee 63 ---------startup.coffee
62 ------/publications 64 ------/publications
63 ---------example.coffee 65 ---------example.coffee
64 ------/email 66 ------/email
65 ---------/send 67 ---------/send
66 ------------example.coffee 68 ------------example.coffee
67 ---------/templates 69 ---------/templates
68 ------------example.handlebars 70 ------------example.handlebars
69 ------/data 71 ------/data
70 ---------/insert 72 ---------/insert
71 ---------/update 73 ---------/update
72 ---------/remove 74 ---------/remove
73 ``` 75 ```
74 76
75 ### Language & Formatting 77 ### Language & Formatting
76 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. 78 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.
77 79
78 ### Functionality 80 ### Functionality
79 81
80 ###### Basic Routing (Not Included Yet, Just Documenting) 82 ###### Basic Routing (Not Included Yet, Just Documenting)
81 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. 83 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.
82 84
83 ###### Authentication (Not Included Yet, Just Documenting) 85 ###### Authentication (Not Included Yet, Just Documenting)
84 A complete authentication pattern complete with: signup, login, and password recovery. Also includes an automated user creation script in `/server/startup.coffee`. 86 A complete authentication pattern complete with: signup, login, and password recovery. Also includes an automated user creation script in `/server/startup.coffee`.
85 87