{"id":47339893,"url":"https://github.com/mavhungutrezzy/campus-connect","last_synced_at":"2026-03-17T22:43:38.463Z","repository":{"id":203233765,"uuid":"709133224","full_name":"mavhungutrezzy/campus-connect","owner":"mavhungutrezzy","description":"The 'Campus Connect' API is a comprehensive system designed to facilitate interactions between students, universities, and bursary providers","archived":false,"fork":false,"pushed_at":"2023-10-29T13:22:27.000Z","size":150,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-01-28T23:10:47.854Z","etag":null,"topics":["api-rest","django","django-rest-framework","docker","postgresql"],"latest_commit_sha":null,"homepage":"https://campusconnect-yph529vr.b4a.run/api/v1/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mavhungutrezzy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-24T04:46:24.000Z","updated_at":"2023-12-04T14:31:30.000Z","dependencies_parsed_at":"2023-11-03T23:31:18.162Z","dependency_job_id":null,"html_url":"https://github.com/mavhungutrezzy/campus-connect","commit_stats":{"total_commits":38,"total_committers":2,"mean_commits":19.0,"dds":0.4736842105263158,"last_synced_commit":"dcabc215c4d6bd0cd4f8dbdbc4ae47c0b4ae774b"},"previous_names":["mavhungutrezzy/campus-connect"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mavhungutrezzy/campus-connect","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mavhungutrezzy%2Fcampus-connect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mavhungutrezzy%2Fcampus-connect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mavhungutrezzy%2Fcampus-connect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mavhungutrezzy%2Fcampus-connect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mavhungutrezzy","download_url":"https://codeload.github.com/mavhungutrezzy/campus-connect/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mavhungutrezzy%2Fcampus-connect/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30633789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T22:38:22.569Z","status":"ssl_error","status_checked_at":"2026-03-17T22:38:11.804Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","django","django-rest-framework","docker","postgresql"],"created_at":"2026-03-17T22:43:37.959Z","updated_at":"2026-03-17T22:43:38.458Z","avatar_url":"https://github.com/mavhungutrezzy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Campus Connect (1.0.0)\n[![Tests](https://github.com/mavhungutrezzy/campus-connect/actions/workflows/django.yml/badge.svg)](https://github.com/mavhungutrezzy/campus-connect/actions/workflows/django.yml)\n[![Django](https://img.shields.io/badge/Django-5.1.2-brightgreen)](href=\"https://www.djangoproject.com/)\n[![Python](https://img.shields.io/badge/Python-3.10-blue)](https://www.python.org)\n[![Django Rest Framework](https://img.shields.io/badge/Django%20REST%20Framework-3.14-orange)](https://www.djangoproject.com/)\n\n\nThe 'Campus Connect' API is a comprehensive system designed to facilitate interactions between students, universities, and bursary providers. It leverages the power of Django REST framework and employs JWT (JSON Web Tokens) for secure authentication. The API provides several features to serve students, including bursaries management, application tracking for bursaries and courses, courses and university information, etc.\n\n## 📖 API Documentation\n\nThe API documentation is available to help you understand how to use the 'Campus Connect' API. You can access the API documentation by visiting the following URL: [Docs](https://campusconnect-yph529vr.b4a.run/api/v1/docs/)\n\n\n## 📖 Installation\n\nThis project can be installed via Pip or Docker. To get started, clone the repository to your local computer and navigate to the project directory.\n\n```shell\n$ git clone https://github.com/yourusername/yourrepository.git\n$ cd yourrepository\n```\n\n### Pip\n\nCreate a virtual environment, activate it, install the project requirements, perform database migrations, create a superuser, and run the development server.\n\n```shell\n$ python -m venv .venv\n\n# Windows\n$ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser\n$ .venv\\Scripts\\Activate.ps1\n\n# macOS\n$ source .venv/bin/activate\n\n(.venv) $ pip install -r requirements.txt\n(.venv) $ python manage.py migrate\n(.venv) $ python manage.py createsuperuser\n(.venv) $ python manage.py runserver\n# Access the site at http://127.0.0.1:8000\n```\n\n### Docker\n\nIf you prefer using Docker with PostgreSQL as the database, update the `DATABASES` section in the `django_project/settings.py` file to match the following configuration:\n\n```python\n# django_project/settings.py\nDATABASES = {\n    \"default\": {\n        \"ENGINE\": \"django.db.backends.postgresql\",\n        \"NAME\": \"postgres\",\n        \"USER\": \"postgres\",\n        \"PASSWORD\": \"postgres\",\n        \"HOST\": \"db\",  # set in docker-compose.yml\n        \"PORT\": 5432,  # default PostgreSQL port\n    }\n}\n```\n\nUpdate the `INTERNAL_IPS` configuration in `django_project/settings.py` as well:\n\n```python\n# config/settings.py\n# django-debug-toolbar\nimport socket\nhostname, _, ips = socket.gethostbyname_ex(socket.gethostname())\nINTERNAL_IPS = [ip[:-1] + \"1\" for ip in ips]\n```\n\nBuild the Docker image, run the container, and execute the standard commands within Docker:\n\n```shell\n$ docker-compose up -d --build\n$ docker-compose exec web python manage.py migrate\n$ docker-compose exec web python manage.py createsuperuser\n# Access the site at http://127.0.0.1:8000\n```\n\n\n## 🧪 Testing\n\nWe use both pytest and Django unittests for testing the 'Campus Connect' API.\n\n### Running pytest\n\nYou can run pytest to execute the project's tests by using the following command:\n\n```shell\n(.venv) $ pytest\n```\n\n### Running Django unittests with Coverage\n\nTo run Django unittests with coverage, use the following command:\n\n```shell\n(.venv) $ coverage run manage.py test\n```\n\nYou can then view the coverage report using:\n\n```shell\n(.venv) $ coverage report\n```\n\nFor a more detailed HTML report, use:\n\n```shell\n(.venv) $ coverage html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmavhungutrezzy%2Fcampus-connect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmavhungutrezzy%2Fcampus-connect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmavhungutrezzy%2Fcampus-connect/lists"}