{"id":16989062,"url":"https://github.com/blackmann/compa","last_synced_at":"2025-03-17T09:30:35.412Z","repository":{"id":218407261,"uuid":"746294736","full_name":"blackmann/compa","owner":"blackmann","description":"🌁 scoodent companion. Stay on top of tertiary school lifestyle with modern experiences.","archived":false,"fork":false,"pushed_at":"2024-05-22T10:38:42.000Z","size":1777,"stargazers_count":39,"open_issues_count":13,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-22T11:35:06.954Z","etag":null,"topics":["prisma","remix","social","typescript"],"latest_commit_sha":null,"homepage":"https://compa.so","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blackmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-01-21T16:40:51.000Z","updated_at":"2024-05-30T09:45:36.578Z","dependencies_parsed_at":"2024-02-02T09:46:57.723Z","dependency_job_id":"87e409f8-3dc8-4d53-b30d-d922fbb4f1b0","html_url":"https://github.com/blackmann/compa","commit_stats":null,"previous_names":["blackmann/compa"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackmann%2Fcompa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackmann%2Fcompa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackmann%2Fcompa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackmann%2Fcompa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blackmann","download_url":"https://codeload.github.com/blackmann/compa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858281,"owners_count":20359253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["prisma","remix","social","typescript"],"created_at":"2024-10-14T03:05:20.833Z","updated_at":"2025-03-17T09:30:34.519Z","avatar_url":"https://github.com/blackmann.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"client/public/sym-outline.svg\" width=\"80\"/\u003e\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eThe COMPA Initiative\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://compa.so\"\u003ecompa.so\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/sc-timetable.png\" style=\"border-radius: 1rem\" width=\"500\"/\u003e\u003c/p\u003e\n\n# Compa\n\nA companion application for students to manage and access resources at their higher education institution.\n\n## About\n\nAs a fresher, settling into school could be easier. You usually need to find:\n\n- Communities/Clubs you are interested in\n- Semester timetables\n- Resources from past semesters\n\nFor continuing students, it's just as hard to find documents or class notes when conversations are scattered across multiple platforms.\n\nBeing a student is hard enough, that's why Compa aims to be the go-to resource for higher education institutions and save you from one source of stress.\n\nYour open, compact, companion and compass. That is _Compa_.\n\n## Features\n\n- [x] Timetable: See the lecture schedule for a semester and import it to your calendar. ❇️\n\n- [x] Discussions: Ask questions, share ideas and interact with other students.\n\n- [ ] Communities: Find and join groups that interest you.\n\n## Schools\n\n- [x] Kwame Nkrumah University of Science and Technology (KNUST) - \u003chttps://knust.compa.so\u003e\n- [x] University of Ghana (UG) - \u003chttps://ug.compa.so\u003e\n- [x] University of Mines and Technology (UMAT) - \u003chttps://umat.compa.so\u003e\n\n### Deploy an instance for your school\n\nIf you'd like to deploy an instance for your school:\n\n1. Submit a PR with the title: `School Request: \u003cSchool Name\u003e`. The PR should be submitted with a file in `client/res` named `\u003cschool_id\u003e.json`. The file's content should follow the format in [knust.json](/client/res/knust.json)\n\n1. After your PR is reviewed and merged, click on the **Deploy on Railway** button below to deploy your instance.\n\n1. Share your app's IP with us under the same PR so we can add a subdomain to compa for your school.\n\n[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/VCnpoP)\n\nNote that you bear the cost of hosting which is $5/month on Railway. You'll also need to set up an AWS compatible bucket. I recommend [Linode Object Storage](https://www.linode.com/docs/guides/platform/object-storage/) which also costs $5/month.\n\nFor email, [Resend](https://resend.com) is used. It's free for 100 mails per day.\n\n\u003e If you need any help, please reach us by mail mail@degreat.co.uk\n\n## Run locally\n\nClone the project:\n\n```bash\ngit clone https://github.com/blackmann/compa\ncd compa\n```\n\nRun the following command to install dependencies and setup Prisma migrations:\n\n```bash\nyarn setup:all\n```\n\nStart the project in dev mode:\n\n```bash\nyarn dev:client\n```\n\n## Contributing\n\nContributions are always welcome! We don't have a code of conduct right now, but we will soon!\n\n## Roadmap\n\nComing soon...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackmann%2Fcompa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackmann%2Fcompa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackmann%2Fcompa/lists"}