Skip to content

Commit 902cdf1

Browse files
committed
Update README
1 parent 8f12ffd commit 902cdf1

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

README.md

+39-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Express-React-HMR-Boilerplate
22

3-
[![Build Status](https://travis-ci.org/gocreating/express-react-hmr-boilerplate.svg?branch=dev)](https://travis-ci.org/gocreating/express-react-hmr-boilerplate)
4-
[![Dependency Status](https://david-dm.org/gocreating/express-react-hmr-boilerplate.svg)](https://david-dm.org/gocreating/express-react-hmr-boilerplate)
3+
A boilerplate for scaffolding production-ready MERN stack projects.
54

6-
This is a boilerplate for scaffolding MERN stack projects with livereload feature supported.
5+
| | master | dev |
6+
| --- | --- | --- |
7+
| Build Status | [![Build Status](https://travis-ci.org/gocreating/express-react-hmr-boilerplate.svg?branch=master)](https://travis-ci.org/gocreating/express-react-hmr-boilerplate) | [![Build Status](https://travis-ci.org/gocreating/express-react-hmr-boilerplate.svg?branch=dev)](https://travis-ci.org/gocreating/express-react-hmr-boilerplate) |
8+
| Dependency Status | [![Dependency Status](https://david-dm.org/gocreating/express-react-hmr-boilerplate.svg)](https://david-dm.org/gocreating/express-react-hmr-boilerplate) | - |
79

810
## Demo
911

@@ -33,6 +35,7 @@ This is a boilerplate for scaffolding MERN stack projects with livereload featur
3335
- Social Authentication
3436
- i18n
3537
- Upload avatar
38+
- Recaptcha
3639
- Ajax progress bar
3740
- Google Analytics
3841
- Admin System
@@ -49,18 +52,40 @@ npm install
4952

5053
Most services this boilerplate provides rely on mongoDB. You must config your own mongoDB URIs. The only thing you need to do is create your own `configs/project/mongo/credential.js` based on the provided template `configs/project/mongo/credential.tmpl.js`.
5154

55+
## Config Nodemailer (Optional)
56+
57+
### Gmail
58+
59+
Here I take the popular gmail service as example.
60+
61+
1. Create your own `configs/project/nodemailer/credential.js`
62+
63+
You can check all supported services [here](https://github.com/nodemailer/nodemailer-wellknown#supported-services)
64+
65+
2. Fix security issue
66+
67+
If you are going to run tests on travis or deploy the app on heroku, you might meet the issue that the app cannot login your gmail account from travis/heroku server. You need to manually authorize permissions to your testing/production servers.
68+
> This is also documented on [nodemailer](https://github.com/nodemailer/nodemailer#tldr-usage-example)
69+
5270
## Config Google Analytics (Optional)
5371

5472
TBD
5573

56-
## Config Facebook Login (Optional)
74+
## Config Social Authentication (Optional)
75+
76+
### Facebook
5777

5878
TBD
5979

60-
## Config LinkedIn Login (Optional)
80+
### LinkedIn
6181

6282
TBD
6383

84+
## Config ReCAPTCHA (Optional)
85+
86+
1. Get your API keys on [reCAPTCHA](https://www.google.com/recaptcha/admin)
87+
2. Save keys in `configs/project/recaptcha/credential.js`.
88+
6489
## Config [Firebase](https://console.firebase.google.com/) (Optional)
6590

6691
Firebase provides 5GB/user file storage for [free](https://firebase.google.com/pricing/) and is backed up by google cloud storage service. Thus we use firebase storage `for free` to host user avatars.
@@ -243,14 +268,18 @@ git flow feature finish upgrade-mirror
243268
- [x] [Google analytics](https://github.com/gocreating/express-react-hmr-boilerplate/commit/9af27196c9bc88764e47a79bd5e0044237c6c5a4)
244269
- [x] [Social Auth for Facebook And LinkedIn](https://github.com/gocreating/express-react-hmr-boilerplate/commit/ccaaa608e7efa0a0c1693ddd7072c0e4e62d003b)
245270
- [x] [Reacr-Router-Redux Integration](https://github.com/gocreating/express-react-hmr-boilerplate/commit/5e4306d20a4feed40290739d0ca6f7bda1920df5)
246-
- [ ] Google Recaptcha
247-
- [ ] Edit User Profile
248-
- [ ] Use react-bootstrap in ErrorList
271+
- [x] [Use react-bootstrap in ErrorList](https://github.com/gocreating/express-react-hmr-boilerplate/commit/e44eb0b078fe7d0610c00a5c63b165f2ed31039f)
272+
- [x] [Google Recaptcha](https://github.com/gocreating/express-react-hmr-boilerplate/commit/5655a29c74fca6f2af4b75538820470b1cfe9619)
273+
- [x] [Mail Service](https://github.com/gocreating/express-react-hmr-boilerplate/commit/616ca6edfae5ba4df361d5d6dbef0a28571e9ea2)
274+
- [x] [Email Verification](https://github.com/gocreating/express-react-hmr-boilerplate/commit/5a6ef757d7499cae71f69b605460ff7868d3a5ec)
275+
- [x] [Edit User Profile](https://github.com/gocreating/express-react-hmr-boilerplate/commit/3b0b475edc9ba05269a15fec96a61930aa154fcc)
276+
- [ ] Landing Page
249277
- [ ] Add License
250278

251279
### v1.0+
252280

253-
- [ ] Facebook Messenger Bot Example
281+
- [ ] Disqus Thread
254282
- [ ] [Stripe](https://stripe.com/) Payment System + Donation Button Example
255-
- [ ] Mail System
283+
- [ ] Facebook Messenger Bot Example
284+
- [ ] Phone Verification
256285
- [ ] Automatically Refresh Token

0 commit comments

Comments
 (0)