mirror of
https://github.com/SrIzan10/featheroom.git
synced 2026-06-06 00:56:49 +00:00
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# featheroom
|
|
|
|
Featheroom is an alternative client to the popular education [Google Classroom](https://classroom.google.com/). It is a web application that allows students to view their assignments, grades, and announcements in a more visually appealing way. It is built using React Native and company.
|
|
|
|
This is a submission for [Hack Club High Seas](https://highseas.hackclub.com).
|
|
|
|
|
|
## Tech stack
|
|
|
|
- React Native
|
|
- Expo
|
|
- React Native Paper
|
|
- Firebase (to be changed to normal Google Cloud on release)
|
|
- Tanstack Query
|
|
- NativeWind (Tailwind)
|
|
|
|
## Platform support
|
|
- [x] Android
|
|
- [ ] iOS (will probably be supported on the first alpha release)
|
|
|
|
## How to run
|
|
|
|
1. Clone the repository
|
|
2. Run `bun install` to install the dependencies
|
|
3. Run `bun run android` to start the development server
|
|
You may also need a google-services.json file to run the app. You can get it from the Firebase console. You may need to run more commands to get it up and running.
|
|
|
|
## Contributing
|
|
|
|
If you can help me out, please do! Note that I'm submitting for High Seas. |