meetulr
diff --git a/‎.env.sample
+19 b/‎.env.sample
+19
diff --git a/‎.github/workflows/linter.yml
+9 b/‎.github/workflows/linter.yml
+9
diff --git a/‎.gitignore
+1 b/‎.gitignore
+1
diff --git a/‎.readthedocs.yml
-22 b/‎.readthedocs.yml
-22
diff --git a/‎CODE_OF_CONDUCT.md
+133 b/‎CODE_OF_CONDUCT.md
+133
diff --git a/‎CONTRIBUTING.md
+19-10 b/‎CONTRIBUTING.md
+19-10
diff --git a/‎INSTALLATION.md
+103 b/‎INSTALLATION.md
+103
diff --git a/‎PR-guidelines.md
+13-12 b/‎PR-guidelines.md
+13-12
@@ -0,0 +1,19 @@
+# 👋 Welcome, we're glad you're setting up an installation of Talawa-api. Copy this 
+# file to .env or set the variables in your local environment manually.
+
+
+# Generate a unique random key, you can use `openssl rand -hex 32` in terminal
+ACCESS_TOKEN_SECRET=
+
+# Generate a unique random key, you can use `openssl rand -hex 32` in terminal
+REFRESH_TOKEN_SECRET=
+
+# if you are using DOCKER use this mongodb url 
+# mongodb://mongo:27017/talawa-api
+# if you are using hosted mongodb, mongodb connection string will look like this
+# mongodb+srv://<username>:<password>@<server_url>/<db_name>?retryWrites=true&w=majority
+# for local instance use this connection string
+# mongodb://localhost:27017/<db_name>?retryWrites=true&w=majority
+
+MONGO_DB_URL=
+
@@ -0,0 +1,9 @@
+name: PR workflow
+on: pull_request
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: stefanoeb/[email protected] 
+
@@ -3,3 +3,4 @@ nodemon.json
 .idea/
 .env
 images/
+.vscode
@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [The Palisadoes Foundation](http://www.palisadoes.org/)
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
@@ -3,6 +3,11 @@ Thank you for your interest in contributing to Talawa API. Regardless of the siz
 
 If you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
 
+## Code of Conduct
+A safe environment is required for everyone to contribute. Read our [Code of Conduct Guide](https://github.com/PalisadoesFoundation/talawa-api/blob/master/CODE_OF_CONDUCT.md) to understand what this means. Let us know immediately if you have unacceptable experiences in this area.
+
+No one should fear voicing their opinion. Respones must be respectful.
+
 ## Ways to Contribute
 If you are ready to start contributing code right away, we have a list of [good first issues](https://github.com/PalisadoesFoundation/talawa-api/labels/good%20first%20issue) that contain issues with a limited scope. 
 
@@ -27,16 +32,13 @@ Make sure you are following [issue report guidelines](https://github.com/Palisad
 #### Pull Requests
 [Pull Request guidelines](https://github.com/PalisadoesFoundation/talawa/blob/master/PR-guidelines.md) is best resource to follow to start working on open issues.
 
-#### Git Flow
-For Talawa API, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work. 
+#### Branching Strategy
 
-The different types of branches we may use are:
-* Feature branches (feature/branch-name)
-* Release branches (release/1.XX)
-* Bug branches  (bugfix/branch-name)
-* Hotfix branches (hotfix/branch-name)
+For Talawa API, we had employed the following branching strategy to simplify the development process and to ensure that only stable code is pushed to the `master` branch:
 
-Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/
+- `develop`: For unstable code and bug fixing
+- `alpha-x.x.x`: For stability teesting
+- `master`: Where the stable production ready code lies
 
 ### Contributing Code
 Code contributions to Talawa come in the form of pull requests. These are done by forking the repo and making changes locally.
@@ -56,8 +58,15 @@ The process of proposing a change to Talawa API can be summarized as:
 10. Ensure the test suite passes, either locally or on CI once a PR has been created. 
 11. Review and address comments on your pull request if requested.
 
-### GSoC
-If you are participating in the 2021 Summer of Code, please read more about us and our processes [here](http://www.palisadoes.org/gsoc/)
+### Internships
+
+We have internship partnerships with a number of organizations. See below for more details.
+
+#### GSoC
+If you are participating in the 2021 Summer of Code, please read more about us and our processes [here](https://palisadoesfoundation.github.io/talawa-docs/docs/internships/gsoc/gsoc-introduction)
+
+#### GitHub Externship
+If you are participating in the 2021 GitHub Externship, please read more about us and our processes [here](https://palisadoesfoundation.github.io/talawa-docs/docs/internships/github/github-introduction)
 
 ### Community
 The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Click [here](https://join.slack.com/t/thepalisadoes-dyb6419/shared_invite/zt-nk79xxlg-OxTdlrD7RLaswu8EO_Q5rg) to join our slack channel.
@@ -0,0 +1,103 @@
+# Installation
+
+Talawa API can be setup to run via `Docker` or node's default package manager `Npm`.
+
+## Docker
+
+Follow these steps to get the api running using docker
+
+1. Install <strong>Docker</strong> if you have not installed it.
+2. Clone this repo to your local machine
+
+   ```sh
+   git clone https://github.com/PalisadoesFoundation/talawa-api
+   cd talawa-api
+   ```
+
+3. Create `.env` file in the root directory of the project
+   `.env` file is used to store the secret or environment variables.
+
+   ```sh
+   touch .env
+   ```
+
+4. Copy (ACCESS_TOKEN_SECRET= , REFRESH_TOKEN_SECRET= , MONGO_DB_URL= ) from the `.env.sample` to your local `.env` and fillup these credentials with your own randomly generated secrets. 
+
+5. You will have to set these variables in `.env` to provide the necessary secrets and connection url.
+
+   Please go through the .env.sample documentation  accordingly and configure your `.env`.
+
+   - ACCESS_TOKEN_SECRET
+   - REFRESH_TOKEN_SECRET
+   - MONGO_DB_URL
+
+6. Now that the enviornment variables are setup. Run the following commands in the terminal.
+
+   This command will build the docker image.
+
+   ```sh
+   sudo docker-compose build
+   ```
+
+   This command will run the container, just use the following command to run the server in future.
+
+   ```sh
+   sudo docker-compose up
+   ```
+
+## Standard Installation
+
+Follow these steps to get the api running using npm
+
+1. Install these dependencies if you don't already have them
+   - [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
+   - [Nodejs](https://nodejs.org/en/)<br>
+   <strong>Note:</strong><em>If you do not have MongoDB on your own system, you can proceed with the connection string. Please ensure the right access permissions and firewall openings for the VM/server where the MongoDB is hosted.</em>
+2. Clone this repo to your local machine
+
+   ```sh
+   git clone https://github.com/PalisadoesFoundation/talawa-api
+   cd talawa-api
+   npm install
+   ```
+
+3. Create `.env` file in the root directory of the project
+   `.env` file is used to store the secret or environment variables.
+
+   ```sh
+   touch .env
+   ```
+
+4. Copy (ACCESS_TOKEN_SECRET= , REFRESH_TOKEN_SECRET= , MONGO_DB_URL= ) from the `.env.sample` to your local `.env` and fillup these credentials with your own randomly generated secrets. 
+
+5. Fill out the following fields:
+
+   - ACCESS_TOKEN_SECRET
+   - REFRESH_TOKEN_SECRET
+   - MONGO_DB_URL
+
+     Please go through the .env.sample documentation  accordingly and configure your `.env`.
+
+6. Install required node packages
+
+   ```sh
+   npm install
+   ```
+
+7. Now that we have all the packages, execute the following command to run the server.
+
+   NB: You only have to execute the following command to run the server in future.
+
+   ```sh
+   npm run start
+   ```
+
+## Testing
+
+```sh
+npm run test
+```
+
+### Standard Installation vs Docker
+
+Docker downloads a lot of large images, if you are short on storage or with slow internet connection prefer using standard development installation.
@@ -6,15 +6,16 @@ In order to give everyone a chance to submit a pull request and contribute to th
 
 1. Do not start working on any open issue and raise a PR unless it is assigned to you.
 2. Pull requests must be based on [open issues](https://github.com/PalisadoesFoundation/talawa-api/issues) available.
-3. Each contributor may only create one pull request at a time. We have this rule in place due to our limited resources - if everyone was allowed to post multiple pull requests we will not be able to review them properly. It is also better for contributors because you can focus on creating one quality PR - so spend time making sure it is as good as it can be.
-4. If the pull request's code quality is not up to par, or it would break the app, it will more likely be closed. So please be careful when creating a PR.
-5. Please follow the [PR template](https://github.com/PalisadoesFoundation/talawa-api/blob/master/templates/pr-template.md). Ensure the PR title clearly describes the problem it is solving. In the description, include the relevant issue number, snapshots and videos after changes added.
-6. If you are borrowing code, please disclose it. It is fine and sometimes even recommended to borrow code, but we need to know about it to assess your work. If we find out that your pull request contains a lot of code copied from elsewhere, we will close the pull request.
-7. All pull request must have test units. If for some reason it is not possible to add tests, please let us know and explain why. In that case, you'll need to tell us what steps you followed to manually test your changes.
-8. No Work In Progress. ONLY completed and working pull requests, and with test units, will be accepted. A WIP would fall under rule 4 and be closed immediately.
-9. Please do not @mention contributors and mentors. Sometimes it takes time before we can review your pull request or answer your questions but we'll get to it sooner or later. @mentioning someone just adds to the pile of notifications we get and it won't make us look at your issue faster.
-10. Do not force push. If you make changes to your pull request, please simply add a new commit as that makes it easy for us to review your new changes. If you force push, we'll have to review everything from the beginning.
-11. PR should be small, easy to review and should follow standard coding styles.
-12. If PR has conflicts because of recently added changes to the same file, resolve issues, test new changes and submit PR again for review.
-13. PRs should be atomic. That is, they should address one item (issue or feature)
-14. After submitting PR, if you are not replying within 48 hours then in that case we may need to assign issue to other contributors based on priority of the issue.
+3. [Use this method to automatically close the issue when the PR is completed.](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
+4. Each contributor may only create one pull request at a time. We have this rule in place due to our limited resources - if everyone was allowed to post multiple pull requests we will not be able to review them properly. It is also better for contributors because you can focus on creating one quality PR - so spend time making sure it is as good as it can be.
+5. If the pull request's code quality is not up to par, or it would break the app, it will more likely be closed. So please be careful when creating a PR.
+6. Please follow the [PR template](https://github.com/PalisadoesFoundation/talawa-api/blob/master/templates/pr-template.md). Ensure the PR title clearly describes the problem it is solving. In the description, include the relevant issue number, snapshots and videos after changes added.
+7. If you are borrowing code, please disclose it. It is fine and sometimes even recommended to borrow code, but we need to know about it to assess your work. If we find out that your pull request contains a lot of code copied from elsewhere, we will close the pull request.
+8. All pull request must have test units. If for some reason it is not possible to add tests, please let us know and explain why. In that case, you'll need to tell us what steps you followed to manually test your changes.
+9. No Work In Progress. ONLY completed and working pull requests, and with test units, will be accepted. A WIP would fall under rule 4 and be closed immediately.
+10. Please do not @mention contributors and mentors. Sometimes it takes time before we can review your pull request or answer your questions but we'll get to it sooner or later. @mentioning someone just adds to the pile of notifications we get and it won't make us look at your issue faster.
+11. Do not force push. If you make changes to your pull request, please simply add a new commit as that makes it easy for us to review your new changes. If you force push, we'll have to review everything from the beginning.
+12. PR should be small, easy to review and should follow standard coding styles.
+13. If PR has conflicts because of recently added changes to the same file, resolve issues, test new changes and submit PR again for review.
+14. PRs should be atomic. That is, they should address one item (issue or feature)
+15. After submitting PR, if you are not replying within 48 hours then in that case we may need to assign issue to other contributors based on priority of the issue.
-Original file line number
+Diff line change
 .idea/
 .env
 images/
 +.vscode