Skip to content

Commit 68e6cf0

Browse files
Merge pull request #1 from codeuino/development
Development
2 parents f88bacc + 4e879b0 commit 68e6cf0

File tree

8 files changed

+710
-451
lines changed

8 files changed

+710
-451
lines changed

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@
1515
---
1616
## What is Donut?
1717

18-
Being inspired from the Cornucopia of various social hub this project has been developed taking into consideration about open source. Well this is an Open Source Social networking hub which act as a bridge between various Developers, Organisations and Open Source aspirants to elaborate on various things like #Projects, #Events, #Discussion on various researches, #Scholarships, #Coding release and various other things updates.
19-
The major priority of this project has been that this platform allows users to make their project "Open Sourced" and relesed them under various open source Organisations, experts which holds up a ring plate on this portal. This platform also make users to introduce and develops various solutions in the form of FOSS softwares to publish them for public use by integrating them with their social cause. Moreover this project can be downloaded by any user, organisation and can be used by them in their own custom way , making it run on their servers.
20-
It is built on Node.js and utilizing mongoose as database.
18+
Being inspired by the Cornucopia of various social hub this project has been developed taking into consideration about open source. Well, this is an Open Source Social networking hub which acts as a bridge between various Developers, Organisations and Open Source aspirants to elaborate on various things like #Projects, #Events, #Discussion on various researches, #Scholarships, #Coding release and various other things updates.
19+
The major priority of this project has been that this platform allows users to make their project "Open Sourced" and released them under various open source Organisations, experts which hold up a ring plate on this portal. This platform also makes users introduce and develops various solutions in the form of FOSS software to publish them for public use by integrating them with their social cause. Moreover, this project can be downloaded by any user, organization and can be used by them in their own custom way, making it run on their servers.
20+
It is built on Node.js and utilizing mongoose as a database.
2121

2222
## Technical Features
2323
--------------------
2424
* Sign Up / Login Authentication
2525
* Node.js basic Password Authentication ( Uses Unique email and Password )
2626
* Third party access login
2727
* Sign Up as a User and Organisation
28-
* Write any Post that act as a Feed ( with various formatting tools, tags effect, etc )
29-
* Propose any project that a person wants to raise as a researched under various organisations and experts.
28+
* Write any Post that acts as a Feed ( with various formatting tools, tags effect, etc )
29+
* Propose any project that a person wants to raise as researched under various organizations and experts.
3030
* Write Events and get updates of various Events happening around.
3131
* Scholarship Raiser, Open Source Internships.
3232
* Open up the environment for the discussion through integrated Discussion platform
3333
* Act with Open Stat
3434
* Appropriate Dashboard with most APIs Activities log of projects and other things.
35-
* Sourced Packaged, Custom made software ( can be change according to needs after downloading it.
36-
* Provides various opportunities to integrate many other Open Source projects recognised by organisations
35+
* Sourced Packaged, Custom made software ( can be changed according to needs after downloading it.
36+
* Provides various opportunities to integrate many other Open Source projects recognized by organizations
3737

3838

3939

@@ -42,11 +42,11 @@ Installation
4242
To get this project running locally on your machine follows the steps below in order:
4343

4444
1. fork this repo
45-
2. clone the forked repo from your github using the command `git clone https://github.com/username/Social-Platform-Donut.git` dont forget to replace the username in the URL
45+
2. clone the forked repo from your GitHub using the command `git clone https://github.com/username/Social-Platform-Donut.git` don't forget to replace the username in the URL
4646

4747
![fork-and-clone](READMEassets/forking-the-repo.gif)
4848

49-
3. Checkout to development branch
49+
3. Checkout to the development branch
5050

5151
```shell
5252
git checkout development
@@ -57,14 +57,23 @@ To get this project running locally on your machine follows the steps below in o
5757
```shell
5858
npm install
5959
```
60-
61-
and then run this command to run on local
60+
5.Setting up the local database instance
61+
You need to have a MongoDB atlas account to create local
62+
https://www.youtube.com/watch?v=KKyag6t98g8
63+
Check out the above link to setup MongoDB atlas.
64+
The mongodb URL should be pasted in credential.js files.
65+
66+
6. run this command to run on local
6267

6368
```shell
6469
nodemon server.js
6570
```
71+
or
72+
```shell
73+
node server.js
74+
```
6675

67-
HURRAY! you have done it just start contributing to the project..
76+
HURRAY! you have done it just start contributing to the project.
6877

6978
Now open your browser and type the link `http://localhost:3000` to continue viewing project.
7079

@@ -86,7 +95,7 @@ For windows user, run this command using [git bash](https://git-scm.com/download
8695
**Commits**
8796
* Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
8897
* 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 )
89-
* 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 afterwards 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 )
98+
* 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 )
9099
* 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.
91100

92101
## Community

0 commit comments

Comments
 (0)