{"id":36536447,"url":"https://github.com/brianrahadi/sfucourses-api","last_synced_at":"2026-01-12T04:54:45.108Z","repository":{"id":269494412,"uuid":"907239415","full_name":"brianrahadi/sfucourses-api","owner":"brianrahadi","description":"REST API server for SFU course outlines, sessions, instructors, and reviews","archived":false,"fork":false,"pushed_at":"2025-10-25T02:20:02.000Z","size":168205,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-25T03:10:02.724Z","etag":null,"topics":["docker","golang","json","makefile","rest-api"],"latest_commit_sha":null,"homepage":"https://api.sfucourses.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brianrahadi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-23T06:27:46.000Z","updated_at":"2025-10-25T02:20:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf4e82e2-2e38-4a56-ae7f-c5ae21f98d9a","html_url":"https://github.com/brianrahadi/sfucourses-api","commit_stats":null,"previous_names":["brianrahadi/sfucourses-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brianrahadi/sfucourses-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianrahadi%2Fsfucourses-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianrahadi%2Fsfucourses-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianrahadi%2Fsfucourses-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianrahadi%2Fsfucourses-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brianrahadi","download_url":"https://codeload.github.com/brianrahadi/sfucourses-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianrahadi%2Fsfucourses-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28335065,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:36:25.062Z","status":"online","status_checked_at":"2026-01-12T02:00:08.677Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["docker","golang","json","makefile","rest-api"],"created_at":"2026-01-12T04:54:44.333Z","updated_at":"2026-01-12T04:54:45.103Z","avatar_url":"https://github.com/brianrahadi.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![project_license][license-shield]][license-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- \u003ca href=\"https://github.com/brianrahadi/sfucourses-api\"\u003e\n    \u003cimg src=\"images/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e --\u003e\n\n\u003ch3 align=\"center\"\u003esfucourses-api\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    REST API server for SFU course outlines, sessions, and instructors\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/brianrahadi/sfucourses-api\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/brianrahadi/sfucourses-api\"\u003eView Demo\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/brianrahadi/sfucourses-api/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/brianrahadi/sfucourses-api/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n[![Product Name Screen Shot][product-screenshot]](https://example.com)\nUnofficial API for accessing SFU course outlines, sections, and instructors robustly and used to power sfucourses.com. Data is pulled from SFU Course Outlines REST API. This API is not affiliated with Simon Fraser University.\n\nSee [api.sfucourses.com](https://api.sfucourses.com)\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Built With\n\n- Golang\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\n- Golang v1.23.3\n\n### Quick Features\n\n- REST API Server - [api.sfucourses.com](https://api.sfucourses.com)\n- Golang Script to fetch outlines, sessions, and sync instructors\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/brianrahadi/sfucourses-api.git\n   ```\n2. Change git remote url to avoid accidental pushes to base project\n   ```sh\n   git remote set-url origin brianrahadi/sfucourses-api\n   git remote -v\n   ```\n\n3. Run the project through air.toml or docker\n\nair is good for development with it's real-time file update sync\n```\nair\n```\n\nDocker is good for its 1-to-1 behaviour with production. You can either use docker build and run or docker compose.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Docker\n\n### Build the Image\n```bash\ndocker build -t sfu-courses-api .\n```\n\n### Run the Container\n```bash\ndocker run -p 8080:8080 sfu-courses-api\n```\n\n### Useful Docker Commands\n```bash\n# View running containers\ndocker ps\n\n# View logs\ndocker logs \u003ccontainer_id\u003e\n\n# View logs live\ndocker logs -f \u003ccontainer_id\u003e\n\n# Stop container\ndocker stop \u003ccontainer_id\u003e\n\n# Remove container\ndocker rm \u003ccontainer_id\u003e\n```\n\nThe API will be available at `http://localhost:8080` once the container is running.\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\nSee the [open issues](https://github.com/brianrahadi/sfucourses-api/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\nVery recommended! very appreciated!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Docker Commands\n\n```\n\n\n### UPDATE_PASSWORD\nRequired for the `/update` endpoint. Set this environment variable to secure manual data updates.\n\n```bash\nexport UPDATE_PASSWORD=\"your-secure-password-here\"\n```\n\n**Usage:**\n```bash\ncurl -X POST http://localhost:8080/update \\\n  -H \"Content-Type: text/plain\" \\\n  -d \"your-secure-password-here\"\n```\n\n**Security Note:** Never commit the actual password to version control. Use environment variables or secrets management in production.\n\n### Git Hooks\nTo set up the pre-commit hooks:\n```bash\ncp hooks/pre-commit .git/hooks/\nchmod +x .git/hooks/pre-commit\n```\n\n\nThis way:\n- The hook templates are version controlled\n- Each developer can set up their own hooks\n- The actual `.git/hooks` directory remains local to each developer's machine\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nBrian Rahadi - brian.rahadi@gmail.com\n\nProject Link: [https://github.com/brianrahadi/sfucourses-api](https://github.com/brianrahadi/sfucourses-api)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\n## Acknowledgments\n\n- https://go.dev/doc/ - Golang Dev docs\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/brianrahadi/sfucourses-api.svg?style=for-the-badge\n[contributors-url]: https://github.com/brianrahadi/sfucourses-api/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/brianrahadi/sfucourses-api.svg?style=for-the-badge\n[forks-url]: https://github.com/brianrahadi/sfucourses-api/network/members\n[stars-shield]: https://img.shields.io/github/stars/brianrahadi/sfucourses-api.svg?style=for-the-badge\n[stars-url]: https://github.com/brianrahadi/sfucourses-api/stargazers\n[issues-shield]: https://img.shields.io/github/issues/brianrahadi/sfucourses-api.svg?style=for-the-badge\n[issues-url]: https://github.com/brianrahadi/sfucourses-api/issues\n[license-shield]: https://img.shields.io/github/license/brianrahadi/sfucourses-api.svg?style=for-the-badge\n[license-url]: https://github.com/brianrahadi/sfucourses-api/blob/master/LICENSE.txt\n[product-screenshot]: images/screenshot.png\n[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge\u0026logo=nextdotjs\u0026logoColor=white\n[Next-url]: https://nextjs.org/\n[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\n[React-url]: https://reactjs.org/\n[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge\u0026logo=vuedotjs\u0026logoColor=4FC08D\n[Vue-url]: https://vuejs.org/\n[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge\u0026logo=angular\u0026logoColor=white\n[Angular-url]: https://angular.io/\n[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge\u0026logo=svelte\u0026logoColor=FF3E00\n[Svelte-url]: https://svelte.dev/\n[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge\u0026logo=laravel\u0026logoColor=white\n[Laravel-url]: https://laravel.com\n[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge\u0026logo=bootstrap\u0026logoColor=white\n[Bootstrap-url]: https://getbootstrap.com\n[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge\u0026logo=jquery\u0026logoColor=white\n[JQuery-url]: https://jquery.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianrahadi%2Fsfucourses-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianrahadi%2Fsfucourses-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianrahadi%2Fsfucourses-api/lists"}