Skip to content

Commit 1750782

Browse files
Fixes for README.md
This fixes the paragraphs for Social Account instructions. The markdown parser of GitHub seems to require a paragraph or title directly before a list, otherwise layouting doesn't work properly. This commit contains those fixes. Logo images are now all using wikipedia's dynamic resize API, so they are now matching in size.
1 parent 3b1c854 commit 1750782

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ If you like my work, please **[donate](https://www.paypal.me/meregnorbert)**. Th
2323
### [Live Demo](http://vemapp.e-paper.space/) (login: test/test1234)
2424

2525
## Features
26+
2627
**Server-side**
2728
* [x] **[Node.JS](https://nodejs.org)** v6.x.x
2829
* [x] **[Express](https://github.com/expressjs/express)**
@@ -64,6 +65,7 @@ If you like my work, please **[donate](https://www.paypal.me/meregnorbert)**. Th
6465
* [x] [Logz.io](http://logz.io/)
6566

6667
## Usage
68+
6769
Install dependencies
6870
```
6971
$ npm install
@@ -91,10 +93,15 @@ $ npm start
9193
## Screenshots
9294

9395
### Login screen
96+
9497
![Login screen](https://cloud.githubusercontent.com/assets/306521/20032026/e2241716-a381-11e6-8ec2-4e0263308762.png)
98+
9599
### Index page after login
100+
96101
![Index page](https://cloud.githubusercontent.com/assets/306521/20032034/e401f10c-a381-11e6-86bb-5325671d32bf.png)
102+
97103
### Devices page
104+
98105
![Devices module](https://cloud.githubusercontent.com/assets/306521/20032035/e5e7ec60-a381-11e6-9481-e1db97126797.png)
99106

100107
## Directory structure
@@ -153,22 +160,31 @@ $ npm start
153160
```
154161

155162
## Bundled server-side
163+
156164
If you want to bundle your NodeJS server-side code run webpack on server code with `npm run build && npm run build:server` command. It if was success, run the server: `npm run start:bundle`
157165

158166
If you want to export bundled version copy these folders & files to the new place:
167+
168+
```txt
159169
- server
160170
- locales
161171
- public
162172
- views
163173
- bundle.js
164174
- package.json
165175
- config.js (optional)
176+
```
166177

167178
Before start, you have to install production dependencies with npm: `npm install --production`
168179

169180
## Obtaining API keys for social signup/login
170181

171-
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Google_2015_logo.svg/1000px-Google_2015_logo.svg.png" width="100">
182+
### Google
183+
184+
![Google Logo](https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Google_2015_logo.svg/128px-Google_2015_logo.svg.png)
185+
186+
These are the instructions for Google:
187+
172188
- Visit [Google Cloud Console](https://cloud.google.com/console/project)
173189
- Click on the **Create Project** button
174190
- Enter *Project Name*, then click on **Create** button
@@ -185,9 +201,12 @@ Before start, you have to install production dependencies with npm: `npm install
185201
- Click on **Create Client ID** button
186202
- Copy and paste *Client ID* and *Client secret* keys into `config.js` file
187203

188-
<hr>
204+
### Facebook
205+
206+
![Facebook Logo](https://upload.wikimedia.org/wikipedia/commons/thumb/7/7c/Facebook_New_Logo_%282015%29.svg/128px-Facebook_New_Logo_%282015%29.svg.png)
207+
208+
These are the instructions for Facebook:
189209

190-
<img src="http://www.doit.ba/img/facebook.jpg" width="100">
191210
- Visit [Facebook Developers](https://developers.facebook.com/)
192211
- Click **My Apps**, then select **Add a New App* from the dropdown menu
193212
- Select **Website** platform and enter a new name for your app
@@ -203,9 +222,12 @@ Before start, you have to install production dependencies with npm: `npm install
203222

204223
**Note:** After a successful sign in with Facebook, a user will be redirected back to home page with appended hash `#_=_` in the URL. It is *not* a bug. See this [Stack Overflow](https://stackoverflow.com/questions/7131909/facebook-callback-appends-to-return-url) discussion for ways to handle it.
205224

206-
<hr>
225+
### GitHub
226+
227+
![GitHub Logo](https://upload.wikimedia.org/wikipedia/commons/thumb/2/24/GitHub_logo_2013_padded.svg/128px-GitHub_logo_2013_padded.svg.png)
228+
229+
These are the instructions for GitHub:
207230

208-
<img src="https://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Logo.png" width="100">
209231
- Go to [Account Settings](https://github.com/settings/profile)
210232
- Select **Applications** from the sidebar
211233
- Then inside **Developer applications** click on **Register new application**
@@ -214,9 +236,12 @@ Before start, you have to install production dependencies with npm: `npm install
214236
- Click **Register application**
215237
- Now copy and paste *Client ID* and *Client Secret* keys into `config.js` file
216238

217-
<hr>
239+
### Twitter
240+
241+
![Twitter Logo](https://upload.wikimedia.org/wikipedia/en/thumb/9/9f/Twitter_bird_logo_2012.svg/64px-Twitter_bird_logo_2012.svg.png)
242+
243+
These are the instructions for Twitter:
218244

219-
<img src="https://g.twimg.com/ios_homescreen_icon.png" width="45">
220245
- Sign in at [https://apps.twitter.com/](https://apps.twitter.com/)
221246
- Click **Create a new application**
222247
- Enter your application name, website and description
@@ -228,6 +253,7 @@ Before start, you have to install production dependencies with npm: `npm install
228253
- Copy and paste *Consumer Key* and *Consumer Secret* keys into `config.js` file
229254

230255
## License
256+
231257
vue-express-mongo-boilerplate is available under the [MIT license](https://tldrlegal.com/license/mit-license).
232258

233259
## Contact

0 commit comments

Comments
 (0)