CONTRIBUTING.md

For the contributors 🫂

Haven't made your first-contribution yet? 😢

Do check our First Contribution repository, where we have provided the guidelines to set up Git and how to make a pull request !

Project setup

Fork and clone the repository

git clone https://github.com/nikhil25803/collegeAPI.git

Change the directory

cd collegeAPI

Folder Structure

📂project
│   
└───📂data
│   │   { JSON files of the data collected }     
│   
└───📂env
|   │   { For virtual environment configuration }   
|    
└───📂helpers
|   │   { Python Scripts to fetch data }
|
└───📂src  
    |   { Python funnctions to filter the data }


    📄.gitignore
    📄CONTRIBUTING.md
    📄main.py
    📄README.md
    📄requirements.txt

Activate the virtual environment

For windows

env\Scripts\Activate.ps1

For Linux

source env/scripts/activate

Install the dependencies

pip install -r requirements.txt

Run the FastAPI server

uvicorn main:app --reload

Once you are done with the changes you wanted to add. Follow the steps to make the pull request.

Create and checkout to the new branch.

git checkout -b <branch_name>

Add the changes

git add .

Commit your change with a proper messagge

git commit -m "Enter your message here"

Make the Pull Request

git push origin <branch_name>

---