Welcome! This repo contains a backend web API that build with FastAPI and allows users to query the College Scorecard API effeciently and quickly. Follow the getting started steps to begin contributing!
Here's how you can set up your development environment:
-
Fork the repository on GitHub.
-
Clone your fork to your local machine:
git clone https://github.com/your-username/campuscompass-api.git cd campuscompass-api/ -
Create and activate virtual environment:
python -m venv venv source venv/bin/activate -
Install dependencies
pip install -r requirements.txt
-
Create Image and Build the Docker Container: The api is containerized using Docker, run the below commands to build and run the containers.
docker-compose build --no-cache docker-compose up -d # -d flag detaches from terminal
To run the application locally, run the following command-
- Start the FastAPI Server:
uvicorn app.main:app --reload
The --reload command will dynamically reload your server with the updated changes.
-
Create a new branch for your development:
git checkout -b feat/your-feature-branch
-
Make your changes and test them with pytest:
pytest
-
If all tests pass commit them:
git commit -am "Add some feature" -
Push the changes to your fork:
git push origin your-feature-branch
-
Submit a Pull Request through GitHub to the original repository.
Linting (with flake8 and black) and testing (with pytest) will be automatically applied to pull requests via GitHub Actions.
- Issues: If you find any bugs or have feature requests, please open an issue in the repository.
We welcome contributions from everyone, whether you are new to the project or a seasoned contributor. Your insights and code contributions will help make Campus Compass API an invaluable tool for accessing educational institution data.
Thank you for considering contributing to Campus Compass API, and we look forward to your valuable contributions!