Skip to content

Commit 4b32342

Browse files
committed
2 parents 44b66a7 + f10ee23 commit 4b32342

File tree

1,750 files changed

+100543
-18025
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,750 files changed

+100543
-18025
lines changed

.gitignore

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,82 @@
1-
node_modules/
1+
### Node ###
2+
# Logs
3+
logs
4+
*.log
5+
npm-debug.log*
6+
yarn-debug.log*
7+
yarn-error.log*
8+
9+
# Runtime data
10+
pids
11+
*.pid
12+
*.seed
13+
*.pid.lock
14+
15+
# Directory for instrumented libs generated by jscoverage/JSCover
16+
lib-cov
17+
18+
# Coverage directory used by tools like istanbul
19+
coverage
20+
21+
# nyc test coverage
22+
.nyc_output
23+
24+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
25+
.grunt
26+
27+
# Bower dependency directory (https://bower.io/)
28+
bower_components
29+
30+
# node-waf configuration
31+
.lock-wscript
32+
33+
# Compiled binary addons (https://nodejs.org/api/addons.html)
34+
build/Release
35+
36+
# Dependency directories
37+
node_modules/
38+
jspm_packages/
39+
package-lock.json
40+
41+
# TypeScript v1 declaration files
42+
typings/
43+
44+
# Optional npm cache directory
45+
.npm
46+
47+
# Optional eslint cache
48+
.eslintcache
49+
50+
# Optional REPL history
51+
.node_repl_history
52+
53+
# Output of 'npm pack'
54+
*.tgz
55+
56+
# Yarn Integrity file
57+
.yarn-integrity
58+
59+
# dotenv environment variables file
60+
.env
61+
62+
# parcel-bundler cache (https://parceljs.org/)
63+
.cache
64+
65+
# next.js build output
66+
.next
67+
68+
# nuxt.js build output
69+
.nuxt
70+
71+
# vuepress build output
72+
.vuepress/dist
73+
74+
# Serverless directories
75+
.serverless
76+
77+
# FuseBox cache
78+
.fusebox/
79+
80+
# Config files
81+
credential.js
82+
secret.js

README.md

Lines changed: 130 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,130 @@
1-
# Donut
2-
3-
[![Slack Status](https://img.shields.io/badge/slack-chat-yellow.svg)](https://codeuino.slack.com) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
4-
5-
![codeuino](READMEassets/codeuino.png)
6-
7-
8-
---
9-
## What is <strong>Donut</strong>?
10-
11-
#### Donut is a social platform by Codeuino, built on node.js and utilizing mongoose as database.
12-
#### A social networking platform provided to bridge gaps between various developers, organisations and open source aspirants to elaborate various things like #projects, #events, #discussion on various researches, #scholarships, #coding release and various other updates.
13-
14-
## Technical Features
15-
--------------------
16-
* Sign up / login authentication
17-
* Node.js basic password authentication (uses unique email and password)
18-
* Third party login access
19-
* Sign up as a user and organisation sign up
20-
* Write any post that act as a feed (with various formatting tools, tags effect, etc.)
21-
* Propose any research-project under various organisations or experts
22-
* Write events and get updates on various events happening around
23-
* Scholarship raiser, open source internships.
24-
* Open up the environment for the discussion through integrated discussion platform
25-
* Act with open stats
26-
* Appropriate dashboard with most API, activity-log of projects and other things.
27-
* Sourced packaged, custom made software (can be change according to needs after downloading it).
28-
* Provides various opportunities to integrate many other Open Source projects recognised by organisations
29-
30-
31-
32-
Installation
33-
------------
34-
To get this project running locally on your machine follow the steps below in order:
35-
36-
1. Fork this repo
37-
2. Clone the forked repo from your github using the command `git clone https://github.com/username/Social-Platform-Donut.git`
38-
_Dont forget to replace the username in the URL_
39-
40-
![fork-and-clone](READMEassets/forking-the-repo.gif)
41-
42-
3. Set up the project locally.
43-
44-
```shell
45-
npm install --save
46-
```
47-
48-
and then run this command
49-
50-
```shell
51-
nodemon server.js
52-
```
53-
54-
4. Go to `http://localhost:3000` to view the project.
55-
56-
![local-setup-gif](READMEassets/running-locally.gif)
57-
58-
## Contributions best practices
59-
60-
**Commits**
61-
* Write clear meaningful git commit messages. (Do read <http://chris.beams.io/posts/git-commit/>)
62-
* Make sure that the description of your pull request contains github's special keyword references that automatically close the related issue when the pull request is merged. (More info at <https://github.com/blog/1506-closing-issues-via-pull-requests>)
63-
* When you make minor changes to your pull request (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>)
64-
* When you're submitting a pull request for a UI related issue, it will be appreciated if you add a screenshot of your change or a link of the deployment where it can be tested along with your pull request. It makes it very easy for the reviewers and you'll also get reviews quicker.
65-
66-
## Community
67-
68-
All feedback and suggestions are welcome!
69-
70-
* 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ )
71-
* 📣 Stay updated on new features and announcements on the following:
72-
1. [@Mailing List]([email protected])
73-
2. [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel)
74-
3. [@Codeuino Wiki](wiki.codeuino.org)
75-
76-
77-
## Sponsors/Partners
78-
79-
Support this project by becoming a sponsor/collaborator/partner/contributors.
80-
[[Become a sponsor](http://codeuino.org/)]
81-
82-
#### Current
83-
84-
<a href="#" target="_blank"><img src="https://secure.meetupstatic.com/photos/event/2/6/d/b/600_456849947.jpeg" width="200" height="100" /></a>
85-
<a href="#" target="_blank"><img src="https://upload.wikimedia.org/wikipedia/commons/f/ff/DigitalOcean_logo.svg" width="200" height="100" /></a>
86-
87-
88-
## Licensing
89-
90-
<b>Donut an Open Source social collaborating platform is a web based framework software,
91-
92-
Copyright (C) < 2018 Codeuino Contributors >
93-
This program is free software: you can redistribute it and/or modify
94-
it under the terms of the GNU General Public License v3 as published by
95-
the Free Software Foundation, either version 3 of the license, or
96-
(at your option) any later version.
97-
98-
This program is distributed in the hope that it will be useful,
99-
but WITHOUT ANY WARRANTY; without even the implied warranty of
100-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
101-
GNU General Public License for more details at OSI <https://opensource.org/licenses/GPL-3.0>
102-
103-
You should have received a copy of the GNU General Public License
104-
along with this program. If not, see <http://www.gnu.org/licenses/>.
1+
## For frontend of this repo move to this repository https://github.com/codeuino/frontened
2+
3+
# Donut-
4+
5+
[![Slack Status](https://img.shields.io/badge/slack-chat-yellow.svg)](https://codeuino.slack.com) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
6+
7+
![codeuino](READMEassets/landing.png)
8+
9+
10+
![codeuino](READMEassets/landing1.png)
11+
![codeuino](READMEassets/landing2.jpg)
12+
![codeuino](READMEassets/landing3.jpg)
13+
![codeuino](READMEassets/landing4.png)
14+
15+
---
16+
## What is Donut?
17+
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.
21+
22+
## Technical Features
23+
--------------------
24+
* Sign Up / Login Authentication
25+
* Node.js basic Password Authentication ( Uses Unique email and Password )
26+
* Third party access login
27+
* 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.
30+
* Write Events and get updates of various Events happening around.
31+
* Scholarship Raiser, Open Source Internships.
32+
* Open up the environment for the discussion through integrated Discussion platform
33+
* Act with Open Stat
34+
* 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
37+
38+
39+
40+
Installation
41+
------------
42+
To get this project running locally on your machine follows the steps below in order:
43+
44+
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
46+
47+
![fork-and-clone](READMEassets/forking-the-repo.gif)
48+
49+
3. Checkout to development branch
50+
51+
```shell
52+
git checkout development
53+
```
54+
55+
4. Setting up the project locally.
56+
57+
```shell
58+
npm install --save
59+
```
60+
61+
and then run this command to run on local
62+
63+
```shell
64+
nodemon server.js
65+
```
66+
67+
HURRAY! you have done it just start contributing to the project..
68+
69+
Now open your browser and type the link `http://localhost:3000` to continue viewing project.
70+
71+
Setting Up Database
72+
------------
73+
Make sure you have MongoDB installed on your computer. If not get it here [MongoDB Community Server](https://www.mongodb.com/download-center/community)
74+
75+
1- Open the terminal, locate the "scripts" folder and run the dbcreater.sh
76+
77+
```shell
78+
bash dbcreater.sh
79+
```
80+
81+
For windows user, run this command using [git bash](https://git-scm.com/download/win)
82+
83+
84+
## Contributions Best Practices
85+
86+
**Commits**
87+
* Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
88+
* 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 )
90+
* 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.
91+
92+
## Community
93+
94+
All feedback and suggestions are welcome!
95+
96+
* 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ )
97+
* 📣 Stay up to date on new features and announcements on the following
98+
1.[@Mailing List]([email protected]).
99+
1.[@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel).
100+
1.[@Codeuino Wiki](wiki.codeuino.org).
101+
102+
103+
## Sponsors/Partners
104+
105+
Support this project by becoming a sponsor/collaborator/partner/contributors.
106+
[[Become a sponsor](https://codeuino.org/)]
107+
108+
#### Current
109+
110+
<a href="#" target="_blank"><img src="https://secure.meetupstatic.com/photos/event/2/6/d/b/600_456849947.jpeg" width="200" height="100" /></a>
111+
<a href="#" target="_blank"><img src="https://upload.wikimedia.org/wikipedia/commons/f/ff/DigitalOcean_logo.svg" width="200" height="100" /></a>
112+
113+
114+
## Licensing
115+
116+
<b>Donut An Open Source Social Collaborating platform is a web Based framework Software,
117+
118+
Copyright (C) < 2018 Codeuino Contributors >
119+
This program is free software: you can redistribute it and/or modify
120+
it under the terms of the GNU General Public License V3 as published by
121+
the Free Software Foundation, either version 3 of the License, or
122+
(at your option) any later version.
123+
124+
This program is distributed in the hope that it will be useful,
125+
but WITHOUT ANY WARRANTY; without even the implied warranty of
126+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
127+
GNU General Public License for more details at OSI <https://opensource.org/licenses/GPL-3.0>
128+
129+
You should have received a copy of the GNU General Public License
130+
along with this program. If not, see <http://www.gnu.org/licenses/>.

READMEassets/forking-the-repo.gif

100755100644
File mode changed.

READMEassets/landing.png

231 KB
Loading

READMEassets/landing1.png

231 KB
Loading

READMEassets/landing2.jpg

258 KB
Loading

READMEassets/landing3.jpg

64.7 KB
Loading

READMEassets/landing4.png

197 KB
Loading

READMEassets/running-locally.gif

100755100644
File mode changed.

config/credential.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
oauth: {
3+
clientID: "192695093229-kf95jtdv1jge25d86ak99e68dkrpu33o.apps.googleusercontent.com",
4+
clientSecret: "rXvfxBahDlJF1ORk7y660XM8"
5+
},
6+
database: 'mongodb://localhost:27017/donut1',
7+
github: {
8+
clientID: 'c9afdb238ed98b213912',
9+
clientSecret: '3031efea8badea1381da682fd5f21e88e5a15d2f'
10+
},
11+
facebook: {
12+
clientID: '383717979035587',
13+
clientSecret: '82bd80d286ef6e45606da6d53a97efbc'
14+
}
15+
}

0 commit comments

Comments
 (0)