@@ -53,6 +53,9 @@ Technical Features
Installation
------------
+
+[](https://nodejs.org/en/) [](http://npmjs.com/)
+
To get this project running locally on your machine follows the steps below in order:
1. fork this repo
@@ -75,10 +78,9 @@ using the command `git clone https://github.com/username/Social-Platform-Donut.g
5. Setting up the local database instance
- You need to have a MongoDB atlas account to create local
- https://www.youtube.com/watch?v=KKyag6t98g8
- Check out the above link to setup MongoDB atlas.
- The mongodb URL should be pasted in credential.js files.
+ You need to have a MongoDB atlas account to create local database.
+ Check out [this link](https://www.youtube.com/watch?v=KKyag6t98g8) to setup MongoDB atlas.
+ The mongodb URL should be pasted in `credential.js` files.
@@ -98,6 +100,10 @@ Now open your browser and type the link `http://localhost:3000` to continue view
Setting Up Database
------------
+
+
+[](https://www.mongodb.com/download-center/community)
+
Make sure you have MongoDB installed on your computer. If not get it here [MongoDB Community Server](https://www.mongodb.com/download-center/community)
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
## Contributions Best Practices
+[](https://github.com/codeuino/Social-Platform-Donut/issues)  
+
**Commits**
-* Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
-* 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 )
-* 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 )
+* Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).
+* 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)
+* 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))
* 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.
## Community
+[](https://github.com/codeuino/Social-Platform-Donut/network) [](https://github.com/codeuino/Social-Platform-Donut/stargazers) 
+
All feedback and suggestions are welcome!
* 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ )
-* 📣 Stay up to date on new features and announcements on the following
-1.[@Mailing List](codeuino-devel@googlegroups.com).
-1.[@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel).
-1.[@Codeuino Wiki](wiki.codeuino.org).
+* 📣 Stay up to date on new features and announcements on the following:
+ - [@Mailing List](codeuino-devel@googlegroups.com).
+ - [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel).
+ - [@Codeuino Wiki](wiki.codeuino.org).
## Sponsors/Partners
@@ -135,12 +145,14 @@ Support this project by becoming a sponsor/collaborator/partner/contributors.
#### Current
-
-
+|
|
|
+|:-:|:-:|
## Licensing
+[](https://github.com/codeuino/Social-Platform-Donut/blob/master/LICENSE)
+
Donut An Open Source Social Collaborating platform is a web Based framework Software,
Copyright (C) < 2018 Codeuino Contributors >
@@ -155,4 +167,7 @@ This program is distributed in the hope that it will be useful,
GNU General Public License for more details at OSI
You should have received a copy of the GNU General Public License
- along with this program. If not, see .
+ along with this program. If not, see [this](http://www.gnu.org/licenses/).
+
+[](https://twitter.com/codeuino) [](https://github.com/codeuino/Social-Platform-Donut)
+