Skip to content

Latest commit

 

History

History
104 lines (71 loc) · 4.9 KB

README.md

File metadata and controls

104 lines (71 loc) · 4.9 KB
Raw

Donut

Slack Status PRs Welcome

codeuino

What is Donut?

Donut is a social platform by Codeuino, built on node.js and utilizing mongoose as database.

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.

Technical Features

  • Sign up / login authentication
  • Node.js basic password authentication (uses unique email and password)
  • Third party login access
  • Sign up as a user and organisation sign up
  • Write any post that act as a feed (with various formatting tools, tags effect, etc.)
  • Propose any research-project under various organisations or experts
  • Write events and get updates on various events happening around
  • Scholarship raiser, open source internships.
  • Open up the environment for the discussion through integrated discussion platform
  • Act with open stats
  • Appropriate dashboard with most API, activity-log of projects and other things.
  • Sourced packaged, custom made software (can be change according to needs after downloading it).
  • Provides various opportunities to integrate many other Open Source projects recognised by organisations

Installation

To get this project running locally on your machine follow the steps below in order:

  1. Fork this repo
  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

fork-and-clone

  1. Set up the project locally.

    npm install --save

    and then run this command

    nodemon server.js

  2. Go to http://localhost:3000 to view the project.

local-setup-gif

Contributions best practices

Commits

  • Write clear meaningful git commit messages. (Do read http://chris.beams.io/posts/git-commit/)
  • 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)
  • 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)
  • 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.

Community

All feedback and suggestions are welcome!

Sponsors/Partners

Support this project by becoming a sponsor/collaborator/partner/contributors. [Become a sponsor]

Current

Licensing

Donut an Open Source social collaborating platform is a web based framework software,

Copyright (C) < 2018 Codeuino Contributors > This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License v3 as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details at OSI https://opensource.org/licenses/GPL-3.0

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.