search

codeuino / social-platform-donut-backend

Donut API:
http://donut-api-prod.codeuino.org/
GNU General Public License v3.0
24 stars 57 forks source link

add docs for new contributors #181

Closed Rupeshiya closed 4 years ago

Rupeshiya commented 4 years ago

name: Pull Request template about: Describe the PR. title: '' labels: '' assignees: ''

Problem

Github Issue Number: #179 Improve docs for new contributors

Solution of problem

Add the links of the docs for reference and describe the workflow to follow to use the platform

Type of Change

[ ] Bug fix [ ] New Feature [ ] Development of UI/UX prototypes [ ] Small refactor [✓] Change in Documentation

Checklist

[✓] My code follows the same style as the codebase [✓] My Code change requires a change in documentation [✓] I have updated the Readme accordingly [✓] I made PR against development branch [✓] I have run the test cases locally and it's passing. [✓] I have squashed my commits

Rupeshiya commented 4 years ago

@vaibhavdaren Plz review

jaskiratsingh2000 commented 4 years ago

Sure, go ahead

On Thu, Aug 27, 2020 at 4:26 AM Rupesh Krishna Jha notifications@github.com wrote:

@Rupeshiya commented on this pull request.

In README.md https://github.com/codeuino/social-platform-donut-backend/pull/181#discussion_r478345276 :

-- bcrypt :- hash your plain password and store hashed password in database. -- body-parser :- Parse incoming request bodies in a middleware before your handlers, available under the req.bodyproperty. -- express :- Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. -- jsonwebtoken :- JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. -- mongoose :- Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment. -- morgan :- HTTP request logger middleware for node.js. -- nodemon :- nodemon will watch the files in the directory in which nodemon was started, and if any files change, nodemon will automatically restart your node application. +NOTE: Make sure you have installed the pre-requisite and setup the environment variables in .env.dev (for development) and .env.test (for unit test) provided in the documentation.

@jaskiratsingh2000 https://github.com/jaskiratsingh2000 Should I write that here too in Readme?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/codeuino/social-platform-donut-backend/pull/181#discussion_r478345276, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACOBHK2NBOQTRYN3YNSASR3SCY7IHANCNFSM4QMHGP5Q .

Rupeshiya commented 4 years ago

@ayushnagar123 @jaskiratsingh2000 @ksraj123 @vaibhavdaren @AuraOfDivinity Please review again

Rupeshiya commented 4 years ago

@vaibhavdaren Please review