{"id":23670480,"url":"https://github.com/ankushkun/class-compass-cu","last_synced_at":"2026-05-09T06:02:19.199Z","repository":{"id":197972630,"uuid":"699776043","full_name":"ankushKun/class-compass-cu","owner":"ankushKun","description":"Codebase for Class Compass - vacant class locator for CU","archived":false,"fork":false,"pushed_at":"2023-12-26T15:00:24.000Z","size":1715,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-11T12:47:59.117Z","etag":null,"topics":["firebase","react-native","university"],"latest_commit_sha":null,"homepage":"https://classcompass.github.io/","language":"JavaScript","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/ankushKun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["ankushKun"]}},"created_at":"2023-10-03T10:13:08.000Z","updated_at":"2024-01-06T14:51:24.000Z","dependencies_parsed_at":"2023-12-26T17:06:38.613Z","dependency_job_id":null,"html_url":"https://github.com/ankushKun/class-compass-cu","commit_stats":null,"previous_names":["ankushkun/class-compass-cu"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ankushKun/class-compass-cu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankushKun%2Fclass-compass-cu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankushKun%2Fclass-compass-cu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankushKun%2Fclass-compass-cu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankushKun%2Fclass-compass-cu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankushKun","download_url":"https://codeload.github.com/ankushKun/class-compass-cu/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankushKun%2Fclass-compass-cu/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32809147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"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":["firebase","react-native","university"],"created_at":"2024-12-29T09:35:48.633Z","updated_at":"2026-05-09T06:02:19.185Z","avatar_url":"https://github.com/ankushKun.png","language":"JavaScript","funding_links":["https://github.com/sponsors/ankushKun"],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"classcompass.github.io\" target=\"_blank\"\u003e\u003cimg src=\"https://classcompass.github.io/icon.png\" width=\"100px\" align=\"right\"\u003e\u003c/a\u003e\n\n# Class Compass CU\n\nCodebase for Class Compass - vacant class locator for CU\n\n\n## Download the app\n\nThe app is available on the Google Play Store. You can download it from the links below:\n\n\u003ccenter\u003e\n      \n\u003ca href=\"https://play.google.com/store/apps/details?id=com.darkweeblet.classcompass\" target=\"_blank\"\u003e\u003cimg width=\"200px\" src=\"https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png\"\u003e\u003c/a\u003e\n      \nApple App Store hopefully coming soon (if we dont stay broke)\n  \n\u003c/center\u003e\n\n## Getting Started\n\n### Tech Stack Used\n\n* [Node.js](https://nodejs.org/en/) - JavaScript runtime (use latest LTS version)\n* [npm](https://www.npmjs.com/) - Package manager\n* [Firebase](https://firebase.google.com/) - Realtime Database \n* [React Native](https://reactnative.dev/) - Cross-platform mobile app framework\n* [Expo](https://expo.io/) - React Native development environment\n\n### Clone the repo\n\nFirst for the repo and clone it to your local machine.\n\nWe assume you already have git installed on your machine. If not, you can download it from [here](https://git-scm.com/downloads).\n\nWe also hope you have setup SSH keys for your github account. If not, you can follow the instructions [here](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh).\n\n\n```bash\ngit clone git@github.com:\u003cYOUR_USERNAME\u003e/class-compass-cu.git\ncd class-compass-cu/RNApp\n```\n\n**NOTE: All commands assume you are inside the `RNApp` directory. If not, it will be mentioned**\n\n### Install dependencies\n\n```bash\nnpm install\n```\n\n### Setup API keys\n\n* Create a new Firebase project\n* Create a new file `.env` in `/RNApp` and add the following environment variables \n\n```env\nEXPO_PUBLIC_API_KEY=FIREBASE_API_KEY\nEXPO_PUBLIC_AUTH_DOMAIN=FIREBASE_AUTH_DOMAIN\nEXPO_PUBLIC_DB_URL=FIREBASE_DB_URL\nEXPO_PUBLIC_PROJ_ID=FIREBASE_PROJECT_ID\nEXPO_PUBLIC_STORAGE_BUCKET=FIREBASE_STORAGE_BUCKET\nEXPO_PUBLIC_MESSAGING_SENDER_ID=FIREBASE_MESSAGE_SENDER_ID\nEXPO_PUBLIC_APP_ID=FIREBASE_APP_ID\nEXPO_PUBLIC_MEASURMENT_ID=FIREBASE_MEASURMENT_ID\n```\n\n* Replace the values with your Firebase project's API keys\n* You will need to install and login to the expo cli to run the app. Follow the instructions [here](https://docs.expo.io/get-started/installation/)\n* You will also need a google-services.json file from Firebase. Add an app, download its google-services.json and place it in `/RNApp`, then upload the file to eas secrets using the following command, as it will be ignored by the build.\n\n``` bash\neas secret:create --scope project --name GOOGLE_SERVICES_JSON --type file --value ./google-services.json\n```\n\n* Also upload the keys in .env file to eas secrets using the following command, as it will be ignored by the build.\n\n``` bash\neas secret:push --scope project --env-file ./.env\n```\n\n### Running the app\n\n#### Creating a development build\n\n```bash\n# For cloud build through EAS\neas build --profile development\n# For local build\neas build --profile development --local\n```\n\nThe dev build should be installed either on a real device or a simulator for development and live testing purposes.\nEvery time new Native code is added to the project through expo or npm a new development build will have to be created and installed.\n\n#### Creating a production build\n\n```bash\n# For cloud build through EAS\neas build --profile production\n# For local build\neas build --profile production --local\n```\n\nThe production build can be installed on any device and will be used for testing before publishing to the app store.\n\n## Contributing\n\nAny and all contributions are welcome! Please create a new issue to report bugs or suggest new features. If you would like to work on an issue, please comment on it to let us know.\n\nAny questions regarding development or build process are welcome on Github, or you can reach out to us at [@darkweebletapps](https://www.instagram.com/darkweebletapps/) on Instagram, or mail us at [darkweeblet@gmail.com](mailto:darkweeblet@gmail.com)\n\n## License\n\n[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]\n[![CC BY-NC-SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa]\n\n\nThis work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].\n\n\n[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/\n[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png\n[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg\n\nSee [LICENSE](/LICENSE) for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankushkun%2Fclass-compass-cu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankushkun%2Fclass-compass-cu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankushkun%2Fclass-compass-cu/lists"}