There are new endpoints added in routes/index.js and routes/opportunity.js, write swagger documentation for them.

You may refer this

Add a boolean field onlyForFemale field in opportunities model, make it required and give default value false

The opportunity_id field is not needed, as we will be using the unique id generated by mongoose for tasks needing id.
It has to be removed from all the places in the project.

I think we should create a User Model for different users , so that they can view various opportunities and apply to them as per their need and requirements , along with this a moderator who can verify if the job posted is genuine or not

Expected Behavior

In the install section of README.md, the command for starting the application is supposed to be npm run start:dev

Current Behavior

By using npm start, we get the error npm ERR! missing script: start

Can I make a PR fixing this issue?

In controllers/opportunity/index.js , managers/opportunity/index.js , services/opportunity/index.js , update the createOpportunity method to create the Opportunity with one more field onlyForFemale.

Prerequisites

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed
• I'm reporting the issue to the correct repository (for multi-repository projects)

Expected Behavior

The marking scheme of GSSOC has been updated and the changes have not been updated in the README file of this project.

• Find the POST Opportunity API and write YAML documentation for it.
• Text Documentation for reference

In the Navbar Replace What we do? with Opportunities and link it to Know About Section.

Refer the image for more clarity:

Inside install instructions, add this link mentioning that You should google_client_id and google_secret by yourself to put in .env

Replace require with ES6 import at all places.

• I am running the latest version
• I checked to make sure that this issue has not already been filed
• I'm reporting the issue to the correct repository (for multi-repository projects)

Expected Behavior

@Manvityagi I guess the User api needs to be integrated. There is no user authentication as of now (while the UI is already ready for this). Since there's no user api hence we are not able to proceed with the (Bookmark/Save and share functionality).
I also checked that the frontend is in React, so probably you guys will be using RESTful APIs. So I wish to contribute to this project by implementing the following features -

• Authentication using JWT
• Routes protection middlewares to prevent unauthorized access of certain routes.

Expected end result :

• User authentication
• We can secure our APIs with this jwt middleware.
• userId, admin access can be stored in jwt which can be decoded in frontend to use further.

Current Behavior

No such API exists as of now.

1. Do the required documentation change here
2. The GET API should be divided into the controllers, services, and managers as per the convention (can lookup the POST API for reference), Refer Project Structure to know the significance of controllers, managers, services.
3. The endpoint should be /opportunities?type=JOB
   The entries should be returned as per the query param type
   The 6 possible values if type query param are -
   'HACKATHON',
   'JOB',
   'INTERNSHIP',
   'SCHOLARSHIP',
   'CONFERENCE',
   'CODINGCOMPETITION',

Add this on top of the readme.md file.

It should be added at the top, just after the first title
Reference: https://shields.io/category/issue-tracking

• Add mongdb in services
• Add script for running tests
• Replace npm install by npm ci

1. Add the PATCH API for opportunities
2. Add corresponding documentation in routes/opportunity.js
3. Add corresponding documentation in documentation/APIS.md

• Make a folder helpers in root dir, and move all the pagination logic in managers/opportunity/index.js to a function in helpers/pagination.js, and use the function after importing in managers/opportunity/index.js.
• The functionality of pagination should not be affected
• This is being done to keep the code clean, modular, and maintainable

Like this

Hello @admin I want to set up other Oauth routes like linkedin and facebook and also Google using Passport.js

• The POST Opportunity API is divided into controllers, services, and managers,
  Tests should be written for each 3 of them.
• Data should be mocked with Sinon.
• This is the first test, so set up for chai, mocha also needs to be done.
• Refer to this for help

1. Use two additional query params - limit and offset
   Instead of returning all the opportunities return something like: limited_query_set = query_set[offset : offset + limit].
   An Example: if offset = 7 & limit = 20, The opportunities 7th to 27th should be returned.
   PS:
   Use
   "DEFAULT_PAGE_LIMIT" - 20
   "DEFAULT_PAGE_OFFSET", - 0
   The changes will be effectively done in /managers/opportunity/index.js in the getOpportunities function.

2. Update the API documentation accordingly inside routes/opportunity.js

1. The GET API currently can filter only on the basis of opportunityType, modify it to filter on the basis of onlyForFemale field also, which is a boolean field in `opportunity schema
2. Tests should be updated
3. Swagger Documentation should be updated

The current code may have some things which can be improved, check out and raise any concerns you may notice.

I would like to work on creating the sign up and login routes and controller for this project as a participant of GSSOC'21.
Please assign this to me and add the relevant tags.

Inside tests/managers/opportunity-test.js - > describe('deleteOpportunity')

• "Test to check exception when the opportunity with given _id does not exist."
• Check this to add multiple it inside describe
• You may think of other test cases and them too

Inside this section https://github.com/Girl-Code-It/Opportunity-Calendar-Backend#documentation-,
update Swagger Docs link with https://opportunity-calendar.herokuapp.com/playground/
and put this link as the first value in the documentation list

Prerequisites

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed
• I'm reporting the issue to the correct repository (for multi-repository projects)

Proposal

body-parser is been deprecated and Express version 4.16+, their own body-parser implementation is now included in the default Express package so there is no need for you to download another dependency.

You have added a line to your code that looks like the following:

• app.use(bodyparser.json());

If you are using Express 4.16+ you can now replace that line with:

• app.use(express.json());

You also have the following code in your environment:

• app.use(bodyParser.urlencoded({extended: true}));

You can replace that with:

• app.use(express.urlencoded());

Feature request:

Add a Github action that automatically labels 'GSSOC21' for the newly created issue.

Is your feature request related to a problem? Please describe. (optional):

Adding labels is extra work for the maintainers, which can be avoided by GitHub action.

set-up the initial starter code. requirements:

• use express
• use mongodb
• use typescript

for reference, you can check this out

Expected Behavior

As of now, the schema in Swagger documentation blocks (written as JSDoc) contains a response schema. This can be extracted into a separate file, and reference whenever needed using $ref. There are two benefits of doing it. It will reduce the file size so that the file can be maintained easily. Second, It will allow us to reuse certain schema in more than one places.

What needs to be done?

Extract the schema to a new file, preferably in docs/ROUTE_FILE_NAME.json(create if necessary). Then reference this file wherever required. For resources, please check Swagger docs (definitions, refs etc).

Similar to this section,
Add the same thing in readme after Technology Stack

Backend Channel on Discord:
#opportunity-calendar-backtend

@Manvityagi I would like to contribute to the project as a gssoc'21 participant ,but the documentation part is not accessible to me on confluence.

This file is not properly formatted.

1. Format it properly
2. Refer this and update the models.md file

Prerequisites

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed
• I'm reporting the issue to the correct repository (for multi-repository projects)

Expected Behavior

Links in the readme to open in a new tab so that it is easier for the user to navigate to GitHub codebase.

Hello @Manvityagi ,
I would like to contribute on backend part of this project as part of GSSOC'21 programme. Willing to discuss more about this project. Add me to relevant group or discord channel whenever it will be created.

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed
• I'm reporting the issue to the correct repository (for multi-repository projects)

Feature Request

I can see that there are apis for creating and fetching the opportunities but no api exists for updating and deleting. @Manvityagi @abdus Kindly look into this issue and assign it to me if it makes sense.

Inside tests/managers/opportunity-test.js - > describe('updateOpportunity')

• "Test to check exception when the opportunity with given _id does not exist."
• Check this to add multiple it inside describe
• You may think of other test cases

The code should be automatically formatted while a commit is made.

You may use this resource for reference.

There's a prettier config file in this repository. Use it to format code before commit. You can use Husky and/or pretty-quick (if you want)

There are new API endpoints added for user authentication with Google Oauth, write tests for them.

• organisationLogoURL field is to be added in the schema,
• Don't keep it required,
• Give default as - https://picsum.photos/200
• Corresponding additions should be done in opportunity schema, APIS wherever required, swagger documentation, tests

GET API Tests are not updated for the pagination feature,
All the tests in controllers, managers, services shall be updated as per the latest version of GET API.

I am a GSSOC'21 participant and would like to add a feature in README.md where the contributors get automatically updated.
Can you please assign this issue to me?

Subtask from issue #5

Prerequisites

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed

Expected Behavior

Sever should run in cluster mode to run multiple instances of the server in fork mode to make it faster.

Current Behavior

Server is currently running in a non cluster mode.

Context

Reason

Module

I would like to work on this issue as a gssoc 21 participant.

Please add test cases to this project. You are free to use any test suite(Mocha, for example). Make sure the tests are written in TypeScript.