blackmann / compa

🌁 scoodent companion. Stay on top of tertiary school lifestyle with modern experiences.

The COMPA Initiative

compa.so

Compa

A companion application for students to manage and access resources at their higher education institution.

About

As a fresher, settling into school could be easier. You usually need to find:

• Communities/Clubs you are interested in
• Semester timetables
• Resources from past semesters

For continuing students, it's just as hard to find documents or class notes when conversations are scattered across multiple platforms.

Being 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.

Your open, compact, companion and compass. That is Compa.

Features

• Timetable: See the lecture schedule for a semester and import it to your calendar. ❇️

• Discussions: Ask questions, share ideas and interact with other students.

• Communities: Find and join groups that interest you.

Schools

• Kwame Nkrumah University of Science and Technology (KNUST) - https://knust.compa.so
• University of Ghana (UG) - https://ug.compa.so

Deploy an instance for your school

If you'd like to deploy an instance for your school:

1. Submit a PR with the title: School Request: <School Name>. The PR should be submitted with a file in client/res named <school_id>.json. The file's content should follow the format in knust.json

2. After your PR is reviewed and merged, click on the Deploy on Railway button below to deploy your instance.

3. Share your app's IP with us under the same PR so we can add a subdomain to compa for your school.

Note 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 which also costs $5/month.

For email, Resend is used. It's free for 100 mails per day.

If you need any help, please reach us by mail [e-mail]

Run locally

Clone the project:

git clone https://github.com/blackmann/compa
cd compa

Run the following command to install dependencies and setup Prisma migrations:

yarn setup:all

Start the project in dev mode:

yarn dev:client

Contributing

Contributions are always welcome! We don't have a code of conduct right now, but we will soon!

Roadmap

Coming soon...