Technologies Used

• React
• Material-UI
• Nest
• Redis
• MySQL
• Nx

Features

• Developer dashboard
• School default UI
• Bootstrap school by importing class halls, teachers, classrooms, subjects, students
• School secretary dashboard
• Timetable generation
• Teacher timetable
• Student timetable
• API subscription through Binance

Setup

Windows

git clone https://github.com/glom-oss/ricly.git
cd ricly
npm install
create a .env file following the .env.skeleton
npx nx serve app
npx nx serve api

Docker

After executing the steps below, you'll access:

• frontend on (http://localhost:4000)
• backend on (http://localhost:8080)

git clone https://github.com/glom-oss/ricly.git
cd ricly
create a .env file following the .env.skeleton
docker-compose up --build --env-file ./.env

Wanna join the team?

• Discord server
• Figma file

Contributing

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are truly appreciated.
• Check out our contribution guidelines for more information.

License

This project is Licensed under the GNU AGPLv3 License. Please go through the License atleast once before making your contribution.

Contributors ✨

Thanks goes to these wonderful people ❤:

Tchakoumi Lorrain 💻 👀 📆 🎨🤔	Kuidja Marco 💻 👀 📆🤔
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!