Skip to content

Commit 1097d88

Browse files
Merge pull request #268 from vinitshahdeo/master
Prettified README.md with Badges
2 parents b4e50f5 + f145cd7 commit 1097d88

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
codeuino's open source social platform <br><br>
88

9-
[![Slack Status](https://img.shields.io/badge/slack-chat-yellow.svg)](https://codeuino.slack.com) [![PRs Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](http://makeapullrequest.com) [![Issues Open](https://img.shields.io/github/issues-raw/codeuino/Social-Platform-Donut.svg?color=orange)](https://github.com/codeuino/Social-Platform-Donut/issues) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
9+
[![Slack Status](https://img.shields.io/badge/slack-chat-yellow.svg?logo=slack)](https://codeuino.slack.com) [![PRs Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?logo=github)](http://makeapullrequest.com) [![Issues Open](https://img.shields.io/github/issues-raw/codeuino/Social-Platform-Donut.svg?color=orange&logo=github)](https://github.com/codeuino/Social-Platform-Donut/issues) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?logo=github)](https://www.gnu.org/licenses/gpl-3.0)
1010

1111
</div>
1212

13-
#### For frontend of this repo move to this repository https://github.com/codeuino/frontened
13+
#### For frontend of this repo move to [this](https://github.com/codeuino/frontened) repository.
1414

1515
<div align='center'>
1616
<img style="border:1px black solid;" height=165px src="READMEassets/signup_community.png">
@@ -53,6 +53,9 @@ Technical Features
5353

5454
Installation
5555
------------
56+
57+
[![NODE JS](http://img.shields.io/badge/NodeJS-required-teal.svg?logo=node.js)](https://nodejs.org/en/) [![NPM](http://img.shields.io/badge/npm-required-red.svg?logo=npm)](http://npmjs.com/)
58+
5659
To get this project running locally on your machine follows the steps below in order:
5760

5861
1. fork this repo
@@ -75,10 +78,9 @@ using the command `git clone https://github.com/username/Social-Platform-Donut.g
7578

7679
5. Setting up the local database instance
7780

78-
You need to have a MongoDB atlas account to create local
79-
https://www.youtube.com/watch?v=KKyag6t98g8
80-
Check out the above link to setup MongoDB atlas.
81-
The mongodb URL should be pasted in credential.js files.
81+
You need to have a MongoDB atlas account to create local database.
82+
Check out [this link](https://www.youtube.com/watch?v=KKyag6t98g8) to setup MongoDB atlas.
83+
The mongodb URL should be pasted in `credential.js` files.
8284

8385

8486

@@ -98,6 +100,10 @@ Now open your browser and type the link `http://localhost:3000` to continue view
98100

99101
Setting Up Database
100102
------------
103+
104+
105+
[![MongoDB](http://img.shields.io/badge/Mongo-DB-green.svg?logo=mongodb)](https://www.mongodb.com/download-center/community)
106+
101107
Make sure you have MongoDB installed on your computer. If not get it here [MongoDB Community Server](https://www.mongodb.com/download-center/community)
102108

103109
1. Open the terminal, locate the "scripts" folder and run the dbcreater.sh
@@ -111,21 +117,25 @@ Note: For windows user, run this command using [git bash](https://git-scm.com/do
111117

112118
## Contributions Best Practices
113119

120+
[![GitHub issues](https://img.shields.io/github/issues/codeuino/Social-Platform-Donut?logo=github)](https://github.com/codeuino/Social-Platform-Donut/issues) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/codeuino/Social-Platform-Donut?logo=git&logoColor=white) ![GitHub contributors](https://img.shields.io/github/contributors/codeuino/Social-Platform-Donut?logo=github)
121+
114122
**Commits**
115-
* Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
116-
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
117-
* When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
123+
* Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).
124+
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)
125+
* When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))
118126
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
119127
120128
## Community
121129
130+
[![GitHub forks](https://img.shields.io/github/forks/codeuino/Social-Platform-Donut?logo=github)](https://github.com/codeuino/Social-Platform-Donut/network) [![GitHub stars](https://img.shields.io/github/stars/codeuino/Social-Platform-Donut?logo=github)](https://github.com/codeuino/Social-Platform-Donut/stargazers) ![GitHub last commit](https://img.shields.io/github/last-commit/codeuino/Social-Platform-Donut?logo=github)
131+
122132
All feedback and suggestions are welcome!
123133
124134
* 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ )
125-
* 📣 Stay up to date on new features and announcements on the following
126-
1.[@Mailing List](codeuino-devel@googlegroups.com).
127-
1.[@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel).
128-
1.[@Codeuino Wiki](wiki.codeuino.org).
135+
* 📣 Stay up to date on new features and announcements on the following:
136+
- [@Mailing List](codeuino-devel@googlegroups.com).
137+
- [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel).
138+
- [@Codeuino Wiki](wiki.codeuino.org).
129139
130140
131141
## Sponsors/Partners
@@ -135,12 +145,14 @@ Support this project by becoming a sponsor/collaborator/partner/contributors.
135145
136146
#### Current
137147
138-
<a href="#" target="_blank"><img src="https://secure.meetupstatic.com/photos/event/2/6/d/b/600_456849947.jpeg" width="200" height="100" /></a>
139-
<a href="#" target="_blank"><img src="https://upload.wikimedia.org/wikipedia/commons/f/ff/DigitalOcean_logo.svg" width="200" height="100" /></a>
148+
| <a href="https://www.womenwhocode.com/"><img src="https://secure.meetupstatic.com/photos/event/2/6/d/b/600_456849947.jpeg" width="200px" height="100px"></a> | <a href="https://www.digitalocean.com/"><img src="https://upload.wikimedia.org/wikipedia/commons/f/ff/DigitalOcean_logo.svg" width="200px" height="100px"></a> |
149+
|:-:|:-:|
140150
141151
142152
## Licensing
143153
154+
[![GitHub license](https://img.shields.io/github/license/codeuino/Social-Platform-Donut?logo=github)](https://github.com/codeuino/Social-Platform-Donut/blob/master/LICENSE)
155+
144156
<b>Donut An Open Source Social Collaborating platform is a web Based framework Software,
145157
146158
Copyright (C) < 2018 Codeuino Contributors >
@@ -155,4 +167,7 @@ This program is distributed in the hope that it will be useful,
155167
GNU General Public License for more details at OSI <https://opensource.org/licenses/GPL-3.0>
156168
157169
You should have received a copy of the GNU General Public License
158-
along with this program. If not, see <http://www.gnu.org/licenses/>.
170+
along with this program. If not, see [this](http://www.gnu.org/licenses/).
171+
172+
[![Twitter Follow](https://img.shields.io/twitter/follow/codeuino?style=social)](https://twitter.com/codeuino) [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/codeuino/Social-Platform-Donut)
173+

0 commit comments

Comments
 (0)