|
1 | | -<div align="center"> |
2 | | - |
3 | | -<img height=200px src="./READMEassets/doughnut.png"> |
4 | | - |
5 | | -<h1>DONUT</h1> |
6 | | - |
7 | | -codeuino's open source social platform <br><br> |
8 | | - |
9 | | -[](https://codeuino.slack.com) [](http://makeapullrequest.com) [](https://github.com/codeuino/Social-Platform-Donut/issues) [](https://www.gnu.org/licenses/gpl-3.0) |
10 | | - |
11 | | -</div> |
12 | | - |
13 | | -#### For frontend of this repo move to [this](https://github.com/codeuino/frontened) repository. |
14 | | - |
15 | | -<div align='center'> |
16 | | -<img style="border:1px black solid;" height=165px src="READMEassets/signup_community.png"> |
17 | | -<img style="border:1px black solid;" height=165px src="READMEassets/landing.gif"> |
18 | | -<img style="border:1px black solid;" height=165px src="READMEassets/signup_user.png"> |
19 | | -<img style="border:1px black solid;" height=165px src="READMEassets/feeds.png"> |
20 | | -<img style="border:1px black solid;" height=165px src="READMEassets/edit_profile.png"> |
21 | | -<img style="border:1px black solid;" height=165px src="READMEassets/dashboard.png"> |
22 | | -</div> |
23 | | - |
24 | | - |
25 | | -What is Donut? |
26 | | --------- |
27 | | -Being inspired by the Cornucopia of various social hub this project has been developed taking into consideration about open source. |
28 | | - |
29 | | - 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. |
30 | | - |
31 | | -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. |
32 | | - |
33 | | -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. |
34 | | -It is built on Node.js and utilizing mongoose as a database. |
35 | | - |
36 | | -Technical Features |
37 | | --------------------- |
38 | | -* Sign Up / Login Authentication |
39 | | -* Node.js basic Password Authentication ( Uses Unique email and Password ) |
40 | | -* Third party access login |
41 | | -* Sign Up as a User and Organisation |
42 | | -* Write any Post that acts as a Feed ( with various formatting tools, tags effect, etc ) |
43 | | -* Propose any project that a person wants to raise as researched under various organizations and experts. |
44 | | -* Write Events and get updates of various Events happening around. |
45 | | -* Scholarship Raiser, Open Source Internships. |
46 | | -* Open up the environment for the discussion through integrated Discussion platform |
47 | | -* Act with Open Stat |
48 | | -* Appropriate Dashboard with most APIs Activities log of projects and other things. |
49 | | -* Sourced Packaged, Custom made software ( can be changed according to needs after downloading it. |
50 | | -* Provides various opportunities to integrate many other Open Source projects recognized by organizations |
51 | | - |
52 | | - |
53 | | - |
54 | | -Installation |
55 | | ------------- |
56 | | - |
57 | | -[](https://nodejs.org/en/) [](http://npmjs.com/) |
58 | | - |
59 | | -To get this project running locally on your machine follows the steps below in order: |
60 | | - |
61 | | -1. fork this repo |
62 | | -2. clone the forked repo from your GitHub |
63 | | -using the command `git clone https://github.com/username/Social-Platform-Donut.git` don't forget to replace the username in the URL |
64 | | - |
65 | | -  |
66 | | - |
67 | | -3. Checkout to the development branch |
68 | | - |
69 | | - ```shell |
70 | | - git checkout development |
71 | | - ``` |
72 | | - |
73 | | -4. Setting up the project locally. |
74 | | - |
75 | | - ```shell |
76 | | - npm install |
77 | | - ``` |
78 | | - |
79 | | -5. Setting up the local database instance |
80 | | - |
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. |
84 | | - |
85 | | - |
86 | | - |
87 | | -6. run this command to run on local |
88 | | - |
89 | | - ```shell |
90 | | - nodemon server.js |
91 | | - ``` |
92 | | - or |
93 | | - ```shell |
94 | | - node server.js |
95 | | - ``` |
96 | | - |
97 | | -HURRAY! you have done it just start contributing to the project. |
98 | | - |
99 | | -Now open your browser and type the link `http://localhost:3000` to continue viewing project. |
100 | | - |
101 | | -Setting Up Database |
102 | | ------------- |
103 | | - |
104 | | - |
105 | | -[](https://www.mongodb.com/download-center/community) |
106 | | - |
107 | | -Make sure you have MongoDB installed on your computer. If not get it here [MongoDB Community Server](https://www.mongodb.com/download-center/community) |
108 | | - |
109 | | -1. Open the terminal, locate the "scripts" folder and run the dbcreater.sh |
110 | | - |
111 | | - ```shell |
112 | | - bash dbcreater.sh |
113 | | - ``` |
114 | | - |
115 | | -Note: For windows user, run this command using [git bash](https://git-scm.com/download/win) |
116 | | - |
117 | | - |
118 | | -## Contributions Best Practices |
119 | | - |
120 | | -[](https://github.com/codeuino/Social-Platform-Donut/issues)   |
121 | | - |
122 | | -**Commits** |
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)) |
126 | | -* 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. |
127 | | -
|
128 | | -## Community |
129 | | -
|
130 | | -[](https://github.com/codeuino/Social-Platform-Donut/network) [](https://github.com/codeuino/Social-Platform-Donut/stargazers)  |
131 | | -
|
132 | | -All feedback and suggestions are welcome! |
133 | | -
|
134 | | -* 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ ) |
135 | | -* 📣 Stay up to date on new features and announcements on the following: |
136 | | - - [@Mailing List]([email protected]). |
137 | | - - [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel). |
138 | | - - [@Codeuino Wiki](wiki.codeuino.org). |
139 | | -
|
140 | | -
|
141 | | -## Sponsors/Partners |
142 | | -
|
143 | | -Support this project by becoming a sponsor/collaborator/partner/contributors. |
144 | | -[[Become a sponsor](https://codeuino.org/)] |
145 | | -
|
146 | | -#### Current |
147 | | -
|
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 | | -|:-:|:-:| |
150 | | -
|
151 | | -
|
152 | | -## Licensing |
153 | | -
|
154 | | -[](https://github.com/codeuino/Social-Platform-Donut/blob/master/LICENSE) |
155 | | -
|
156 | | -<b>Donut An Open Source Social Collaborating platform is a web Based framework Software, |
157 | | - |
158 | | - Copyright (C) < 2018 Codeuino Contributors > |
159 | | -This program is free software: you can redistribute it and/or modify |
160 | | - it under the terms of the GNU General Public License V3 as published by |
161 | | - the Free Software Foundation, either version 3 of the License, or |
162 | | - (at your option) any later version. |
163 | | -
|
164 | | -This program is distributed in the hope that it will be useful, |
165 | | - but WITHOUT ANY WARRANTY; without even the implied warranty of |
166 | | - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
167 | | - GNU General Public License for more details at OSI <https://opensource.org/licenses/GPL-3.0> |
168 | | -
|
169 | | -You should have received a copy of the GNU General Public License |
170 | | - along with this program. If not, see [this](http://www.gnu.org/licenses/). |
171 | | -
|
172 | | -[](https://twitter.com/codeuino) [](https://github.com/codeuino/Social-Platform-Donut) |
173 | | -
|
| 1 | +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 2 | + |
| 3 | +## Available Scripts |
| 4 | + |
| 5 | +In the project directory, you can run: |
| 6 | + |
| 7 | +### `npm start` |
| 8 | + |
| 9 | +Runs the app in the development mode.<br /> |
| 10 | +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 11 | + |
| 12 | +The page will reload if you make edits.<br /> |
| 13 | +You will also see any lint errors in the console. |
| 14 | + |
| 15 | +### `npm test` |
| 16 | + |
| 17 | +Launches the test runner in the interactive watch mode.<br /> |
| 18 | +See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 19 | + |
| 20 | +### `npm run build` |
| 21 | + |
| 22 | +Builds the app for production to the `build` folder.<br /> |
| 23 | +It correctly bundles React in production mode and optimizes the build for the best performance. |
| 24 | + |
| 25 | +The build is minified and the filenames include the hashes.<br /> |
| 26 | +Your app is ready to be deployed! |
| 27 | + |
| 28 | +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 29 | + |
| 30 | +### `npm run eject` |
| 31 | + |
| 32 | +**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 33 | + |
| 34 | +If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 35 | + |
| 36 | +Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 37 | + |
| 38 | +You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
| 39 | + |
| 40 | +## Learn More |
| 41 | + |
| 42 | +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 43 | + |
| 44 | +To learn React, check out the [React documentation](https://reactjs.org/). |
| 45 | + |
| 46 | +### Code Splitting |
| 47 | + |
| 48 | +This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
| 49 | + |
| 50 | +### Analyzing the Bundle Size |
| 51 | + |
| 52 | +This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
| 53 | + |
| 54 | +### Making a Progressive Web App |
| 55 | + |
| 56 | +This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
| 57 | + |
| 58 | +### Advanced Configuration |
| 59 | + |
| 60 | +This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
| 61 | + |
| 62 | +### Deployment |
| 63 | + |
| 64 | +This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
| 65 | + |
| 66 | +### `npm run build` fails to minify |
| 67 | + |
| 68 | +This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
0 commit comments