Skip to content

Commit 34b6009

Browse files
committed
adding the initial starting your first app section
1 parent fe59b33 commit 34b6009

File tree

13 files changed

+74
-16
lines changed

13 files changed

+74
-16
lines changed

SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* [Parse](getting-started/vs/parse.md)
1212
* [Pusher](getting-started/vs/pusher.md)
1313
* [Quick Start](getting-started/quick-start.md)
14-
* [Your First App](getting-started/your-first-app.md)
14+
* [Your First App](getting-started/your-first-app/readme.md)
1515
* [Services](services/readme.md)
1616
* [REST](providers/rest.md)
1717
* [Real-Time](providers/real-time/readme.md)
@@ -48,7 +48,7 @@
4848
* React and React Native
4949
* CanJS
5050
* [Help](help/readme.md)
51-
* [FAQ](faq.md)
51+
* [FAQ](help/faq.md)
5252
* [Contributing](contributing.md)
5353
* [Changelog](changelog.md)
5454
* [License](license.md)

contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Just like Feathers itself, all of the documentation is open source and [availabl
44

55
## Contributing Guidelines
66

7-
The docs are all written in [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). If you've used GitHub, it's pretty likely you've encountered it before. You can become a pro in a few minutes by reading their [GFM Documenation page](https://help.github.com/articles/github-flavored-markdown/).
7+
The docs are all written in [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). If you've used GitHub, it's pretty likely you've encountered it before. You can become a pro in a few minutes by reading their [GFM Documentation page](https://help.github.com/articles/github-flavored-markdown/).
88

99
### Organizing Files
1010

getting-started/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Generate your app and follow the prompts.
1414

1515
`yo feathers`
1616

17-
Start your brand new app! :boom:
17+
Start your brand new app! 💥
1818

1919
`npm start`
2020

@@ -26,4 +26,4 @@ Start your brand new app! :boom:
2626

2727
In just a couple minutes we created a real-time API that is accessible via REST and websockets! Based on the options you chose it connected to your database, already provides CORs, authentication, sane rate limiting, pagination, logging, error handling, and a few other goodies.
2828

29-
This is a great start! Let's take this a bit further and [build your first real application](your-first-app.md).
29+
This is a great start! Let's take this a bit further and [build your first real application](your-first-app/readme.md).

getting-started/your-first-app.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
53.8 KB
Loading
37.1 KB
Loading
Loading
52.4 KB
Loading
95.6 KB
Loading
50.6 KB
Loading
Loading
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Your First App
2+
3+
Well alright! Let's build your first Feathers app! We're going to build a real-time chat app with MongoDB as the database. It's a great way to cover all the things that you'd need to do in a real world application and how Feathers can help. It also makes a lot more sense to have a real-time component than a Todo list. 😉
4+
5+
If you've already gone through the [Quick Start](quick-start.md) section you can skip ahead to [What Just Happened?](#what-just-happened).
6+
7+
## Generate Your App
8+
9+
Make sure you have NodeJS and npm installed. You can grab these from the [NodeJS](https://nodejs.org) website or if you are on OS X and have homebrew installed by running `brew install nodejs`.
10+
11+
Install the Yeoman and the Feathers generator.
12+
13+
> `npm install -g yeoman generator-feathers`
14+
15+
Create a directory for your new app.
16+
17+
> `mkdir feathers-chat; cd feathers-chat/`
18+
19+
Generate your app and follow the prompts.
20+
21+
`yo feathers`
22+
23+
When presented with the project name just hit enter.
24+
25+
<img src="./assets/step1.png" alt="App Name Prompt">
26+
27+
Enter in a short description of your app.
28+
29+
<img src="./assets/step2.png" alt="App Description Prompt">
30+
31+
You can now choose which providers you want to support. Since we're setting up a real-time REST API we'll go with the default REST and Socket.io. So just hit enter.
32+
33+
You can learn more about Feathers providers in [Providers chapter](providers/readme.md).
34+
35+
<img src="./assets/step3.png" alt="Transport Prompt">
36+
37+
Next we'll be prompted to support [CORs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS). This basically allows your client to connect to the sever from wherever. You can whitelist specific domains but again, just hit enter for now.
38+
39+
<img src="./assets/step4.png" alt="CORs Prompt">
40+
41+
Now let's choose our database. You can see that Feathers supports a bunch through the generator and we support even more outside the generator. Let's choose MongoDB. You can find out more about our database adapters in the [Databases chapter](databases/readme.md).
42+
43+
<img src="./assets/step5.png" alt="Database Prompt">
44+
45+
Since pretty much every app needs authentication of some sort we generate almost everything you need to get going. We currently only support local authentication but have plans for social auth as well.
46+
47+
You can learn more about authentication in Feathers by reading the [Authentication chapter](authentication/readme.md).
48+
49+
<img src="./assets/step6.png" alt="Authentication Prompt">
50+
51+
Your options should all look like this and you should have seen that a whole bunch of files were created.
52+
53+
<img src="./assets/step7.png" alt="Final Configuration">
54+
55+
npm will do it's thing and install your dependencies. Depending on your Internet connection this can take a minute or two. So while this is happening you should start your mongodb instance.
56+
57+
If you are running on OSX or Linux and already have MongoDB installed simply run:
58+
59+
`mongod`
60+
61+
Once your dependencies have been installed you can start your brand new app! 💥
62+
63+
`npm start`
64+
65+
## What Just Happened
66+
67+
68+

help/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
There are many ways that you can get help but before you explore them please check other parts of this guide, the [FAQ](faq.md), [Stackoverflow](http://stackoverflow.com/questions/tagged/feathersjs), [Github Issues](https://github.com/feathersjs/feathers/issues) and our Medium publication ["All About FeathersJS"](https://medium.com/all-about-feathersjs).
44

5-
If none of those work it's a very real possibility that we screwed something up or it's just not clear. We're sorry :cry:. We want to know about it and are very friendly so feel free to come talk to us in [Slack](http://slack.feathersjs.com/), [submit your issue](https://github.com/feathersjs/feathers/issues/new) on Github or ask on [StackOverflow](http://stackoverflow.com) using the [feathersjs](http://stackoverflow.com/questions/tagged/feathersjs) tag.
5+
If none of those work it's a very real possibility that we screwed something up or it's just not clear. We're sorry 😥. We want to know about it and are very friendly so feel free to come talk to us in [Slack](http://slack.feathersjs.com/), [submit your issue](https://github.com/feathersjs/feathers/issues/new) on Github or ask on [StackOverflow](http://stackoverflow.com) using the [feathersjs](http://stackoverflow.com/questions/tagged/feathersjs) tag.

0 commit comments

Comments
 (0)