Clueless-Community / collegeAPI

An API that helps you to fetch colleges and their details.
GNU General Public License v3.0
56 stars 60 forks source link

Ideas for Winter of Code ( WOC ) 2023 #167

Closed nikhil25803 closed 1 year ago

nikhil25803 commented 1 year ago

What would you like to share?

The following features will be integrated during WOC'23

  1. Refactor the codebase, with optimization following good practices for Python and FastAPI.
  2. Enabling API key authentication for endpoints.
  3. Integrate rate limiting.
  4. Build a Linux container image, using Docker
  5. Improve documentation.
  6. Deployment.

Additional information

Regarding the deployment We will first try to deploy this project, with a dedicated website where a user can login/signup and generate an access key to use this API. If that doesn't work, we'll deploy it on RapidAPI.