add docs for new contributors #181
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@vaibhavdaren Plz review |
ksraj123
suggested changes
Aug 27, 2020
|
Sure, go ahead
…On Thu, Aug 27, 2020 at 4:26 AM Rupesh Krishna Jha ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In README.md
<#181 (comment)>
:
>
-- 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
<#181 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ACOBHK2NBOQTRYN3YNSASR3SCY7IHANCNFSM4QMHGP5Q>
.
|
ayushnagar123
approved these changes
Aug 27, 2020
Rupeshiya
force-pushed
the
documentation
branch
from
a21079e
to
b3d7909
Compare
|
@ayushnagar123 @jaskiratsingh2000 @ksraj123 @vaibhavdaren @AuraOfDivinity Please review again |
ksraj123
approved these changes
Aug 27, 2020
AuraOfDivinity
approved these changes
Aug 27, 2020
ayushnagar123
approved these changes
Aug 27, 2020
|
@vaibhavdaren Please review |
vaibhavdaren
added a commit
that referenced
this pull request
Sep 13, 2020
* added update restrictions, techStacks in project and orgId to a user * added edit restriction mechanism * intial deactivation mechanism * intial logging mechanism and deactive account * issue fix * fixing org creation issue * Fixes issues in testing (#160) * fix failing test file user.test.js * fixes EADDRINUSE while testing * fixes issues in prposal route * fixed issues in org route and added new tests * Moving Google Analytics requests to backend (#154) * Moving Google Analytics requetss to backend * Requested Changes * Minor changes * Adding code to prevent attacks (#153) * modified user's api (#168) * modified user's api * login options during login * Changes for reactions (#166) * Revert "Adding code to prevent attacks (#153)" (#170) This reverts commit 57a0cf9. * Fixed and written all the missing test cases (#172) * update code * fixed failing test cases and missing test cases * User activity tracker using redis (#174) * update code * initial mechanism for user tracking initial mechanism for user tracking * Security issue (#177) * update code * fix security flaws * fixed test cases * minor fixes (#178) * add docs for new contributors (#181) Co-authored-by: Devesh Verma <[email protected]> Co-authored-by: Kumar Saurabh Raj <[email protected]> Co-authored-by: Asel Peiris <[email protected]> Co-authored-by: pranjals149 <[email protected]> Co-authored-by: Vaibhav D. Aren <[email protected]>
vaibhavdaren
added a commit
that referenced
this pull request
Sep 13, 2020
* added update restrictions, techStacks in project and orgId to a user * added edit restriction mechanism * intial deactivation mechanism * intial logging mechanism and deactive account * issue fix * fixing org creation issue * Fixes issues in testing (#160) * fix failing test file user.test.js * fixes EADDRINUSE while testing * fixes issues in prposal route * fixed issues in org route and added new tests * Moving Google Analytics requests to backend (#154) * Moving Google Analytics requetss to backend * Requested Changes * Minor changes * Adding code to prevent attacks (#153) * modified user's api (#168) * modified user's api * login options during login * Changes for reactions (#166) * Revert "Adding code to prevent attacks (#153)" (#170) This reverts commit 57a0cf9. * Fixed and written all the missing test cases (#172) * update code * fixed failing test cases and missing test cases * User activity tracker using redis (#174) * update code * initial mechanism for user tracking initial mechanism for user tracking * Security issue (#177) * update code * fix security flaws * fixed test cases * minor fixes (#178) * add docs for new contributors (#181) * frontend sync master gsoc (#169) (#191) * added update restrictions, techStacks in project and orgId to a user * added edit restriction mechanism * intial deactivation mechanism * intial logging mechanism and deactive account * issue fix * fixing org creation issue * Fixes issues in testing (#160) * fix failing test file user.test.js * fixes EADDRINUSE while testing * fixes issues in prposal route * fixed issues in org route and added new tests * Moving Google Analytics requests to backend (#154) * Moving Google Analytics requetss to backend * Requested Changes * Minor changes * Adding code to prevent attacks (#153) * modified user's api (#168) * modified user's api * login options during login * Changes for reactions (#166) Co-authored-by: Rupeshiya <[email protected]> Co-authored-by: Devesh Verma <[email protected]> Co-authored-by: Kumar Saurabh Raj <[email protected]> Co-authored-by: Asel Peiris <[email protected]> Co-authored-by: pranjals149 <[email protected]> Co-authored-by: Devesh Verma <[email protected]> Co-authored-by: Vaibhav D. Aren <[email protected]> Co-authored-by: Kumar Saurabh Raj <[email protected]> Co-authored-by: Asel Peiris <[email protected]> Co-authored-by: pranjals149 <[email protected]> Co-authored-by: Rupeshiya <[email protected]> Co-authored-by: Devesh Verma <[email protected]> Co-authored-by: Kumar Saurabh Raj <[email protected]> Co-authored-by: Asel Peiris <[email protected]> Co-authored-by: pranjals149 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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