Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 654c2a5

Browse files
authored
Merge pull request #44 from r-park/dev
chore(docs): update readme
2 parents 74e6ce3 + 31213ea commit 654c2a5

File tree

1 file changed

+52
-13
lines changed

1 file changed

+52
-13
lines changed

‎README.md‎

Lines changed: 52 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,27 @@
22

33

44
# Todo app with React, Redux, and Firebase
5-
A simple Todo app example with `undelete` capability — built with React, Redux, and Firebase v3.
5+
A simple Todo app example with **undelete** capability — built with React, Redux, and Firebase.
66

7-
Try the demo at <a href="https://todo-react-redux.firebaseapp.com" target="_blank">todo-react-redux.firebaseapp.com</a>.
7+
Try the demo at https://todo-react-redux.firebaseapp.com.
8+
9+
10+
## Stack
811

912
- React
1013
- React-Hot-Loader `3.0.0-beta.2`
1114
- React-Redux
1215
- React-Router
1316
- React-Router-Redux
1417
- Redux
18+
- Redux-Thunk
1519
- Redux-Devtools-Extension for Chrome
20+
- Firebase SDK 3 with OAuth authentication
1621
- Babel
17-
- Firebase `3.0.2`
18-
- JSON Datastore
19-
- OAuth authentication with GitHub, Google, and Twitter
20-
- Hosting
22+
- Immutable
23+
- Reselect
2124
- SASS
2225
- Webpack
23-
- Webpack dev server
24-
- Hot-reloading
25-
- Compile SASS
26-
- Inject css and js dependencies into html
2726

2827

2928
Quick Start
@@ -36,16 +35,56 @@ $ npm install
3635
$ npm start
3736
```
3837

38+
## Deploying to Firebase
39+
#### Prerequisites:
40+
- Create a free Firebase account at https://firebase.google.com
41+
- Create a project from your [Firebase account console](https://console.firebase.google.com)
42+
- Configure the authentication providers for your Firebase project from your Firebase account console
43+
44+
#### Configure this app with your project-specific details:
45+
```javascript
46+
// .firebaserc
47+
48+
{
49+
"projects": {
50+
"default": "your-project-id"
51+
}
52+
}
53+
```
54+
```javascript
55+
// src/core/firebase/config.js
56+
57+
export const firebaseConfig = {
58+
apiKey: 'your api key',
59+
authDomain: 'your-project-id.firebaseapp.com',
60+
databaseURL: 'https://your-project-id.firebaseio.com',
61+
storageBucket: 'your-project-id.appspot.com'
62+
};
63+
```
64+
65+
#### Install firebase-tools:
66+
```shell
67+
$ npm install -g firebase-tools
68+
```
69+
70+
#### Build and deploy the app:
71+
```shell
72+
$ npm run build
73+
$ firebase login
74+
$ firebase use default
75+
$ firebase deploy
76+
```
77+
3978

40-
Commands
41-
--------
79+
NPM Command Summary
80+
-------------------
4281

4382
|Script|Description|
4483
|---|---|
4584
|`npm start`|Start webpack development server @ `localhost:3000`|
4685
|`npm run build`|Lint, test, and build the application to `./target`|
4786
|`npm run dev`|Same as `npm start`|
4887
|`npm run lint`|Lint `.js` files|
49-
|`npm run server`|Start express server @ `localhost:3000` to serve built artifacts from `./target` (must run `npm run build` first)|
88+
|`npm run server`|Start express server @ `localhost:3000` to serve build artifacts from `./target` (must run `npm run build` first)|
5089
|`npm test`|Run unit tests with Karma and Jasmine|
5190
|`npm run test:watch`|Run unit tests with Karma and Jasmine; watch for changes to re-run tests|

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /