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

Typos and other fixes in How It Works section

Browse Source
This commit is contained in:
Sahat Yalkabov
2014-01-30 08:02:32 -05:00
parent a1fd305b4a
commit 94108729ca
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -409,13 +409,13 @@ If you just want to display a page, then use `GET`, if you are submitting a form
Here is a typical workflow of adding new routes to your application. Let's say we are building Here is a typical workflow of adding new routes to your application. Let's say we are building
a page that lists all books from the database. a page that lists all books from the database.
1. Start by defining a route. **Step 1.** Start by defining a route.
```js ```js
app.get('/books', bookController.getBooks); app.get('/books', bookController.getBooks);
``` ```
2. Create a new controller file called `book.js`.
**Step 2.** Create a new controller file called `book.js`.
```js ```js
/** /**
* GET /books * GET /books
@ -429,12 +429,12 @@ exports.getBooks = function(req, res) {
}; };
``` ```
3. Import that controller in `app.js`. **Step 3.** Import that controller in `app.js`.
```js ```js
var bookController = require('./controllers/book'); var bookController = require('./controllers/book');
``` ```
4. Create a books.jade template. **Step 4.** Create `books.jade` template.
```jade ```jade
extends layout extends layout
@ -447,7 +447,7 @@ block content
li= book.name li= book.name
``` ```
That's it! I must say that you could have combined Step 1,2,3 as following: That's it! I will say that you could have combined Step 1, 2, 3 as following:
```js ```js
app.get('/books', function(req, res) { app.get('/books', function(req, res) {
@ -457,8 +457,8 @@ app.get('/books', function(req, res) {
}); });
``` ```
Sure, it's simpler, but as soon as you pass 1000 lines of code in `app.js` it becomes difficult to manage. Sure, it's simpler, but as soon as you pass 1000 lines of code in `app.js` it becomes a little difficult to navigate the file.
I mean, the whole point of this boilerplate was to separate concerns, so you could I mean, the whole point of this boilerplate project was to separate concerns, so you could
work with your teammates without running into *MERGE CONFLICTS*. Imagine you have 4 developers work with your teammates without running into *MERGE CONFLICTS*. Imagine you have 4 developers
working on a single `app.js`, I promise you it won't be fun resolving merge conflicts all the time. working on a single `app.js`, I promise you it won't be fun resolving merge conflicts all the time.
If you are the only developer then it's fine. But as I said, once it gets up to a certain LoC size, it becomes If you are the only developer then it's fine. But as I said, once it gets up to a certain LoC size, it becomes
@ -466,9 +466,9 @@ difficult to maintain everything in a single file.
That's all there is to it. Express.js is super simple to use. That's all there is to it. Express.js is super simple to use.
Most of the time you will be dealing with other APIs to do the real work: Most of the time you will be dealing with other APIs to do the real work:
Mongoose for querying the database, socket.io for sending and receiving messages over websockets, [Mongoose](http://mongoosejs.com/docs/guide.html) for querying the database, socket.io for sending and receiving messages over websockets,
sending emails via Nodemailer, form validation using express-validatory library, sending emails via [Nodemailer](http://www.nodemailer.com/), form validation using [express-validator](https://github.com/ctavan/express-validator) library,
parsing websites using Cheerio, and etc. parsing websites using [Cheerio](https://github.com/MatthewMueller/cheerio), and etc.
<hr> <hr>