Mağara
Welcome to the Mağara codebase. Let's build something awesome for students.
What is Mağara?
Mağara is a platform where college and university students can find accommodation with ease. Mağara's key difference from other housing applications is the ability for tertiary institutions to install a local and customized instance on their servers. This saves institutions from paying exorbitant installation, maintenance and uninstall fees.
There are two versions of Mağara:
- Our self-hosted version
- Download and install on your on-premises server
Codebase
The stack
Mağara runs top of Ruby on Rails, and it does not have JavaScript on the front end. It uses jQuery, Popper.js for Bootstrap.
Getting started
Prerequisites
💡 Docker and Compose are not requirement, but you can easily setup up a PostgreSQL or other services.
📖 System specific developer installation guides are available on Wiki.
- Ruby: Check out the Ruby version on the badge.
- Yarn: please refer to their installation guide.
- Docker Compose: again, please refer to their installation guide.
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Please see the LICENSE file in our repository for the full text.
Additionally, this program's wiki, /docs and other documentation pages are
released under the Creative Commons BY-SA 4.0.
The Mağara logo © 2018 Berkhan Berkdemir, and it is released under the Creative Commons BY-SA 4.0.