RooFiS 2

Room Finding Service Version 2.0
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

"RooFiS2" or "Room Finder Service2" is a room search for free learning rooms at the Otto-Friedrich University Bamberg. The search is limited by day and time and can be further restricted by location and minimum number of persons.

For the implementation the UnivIS PRG interface is used, which is accessed via the json univis api (see the following repository).

The project is a rewrite to the well-known RooFiS service, which was developed by a former student council member of the WIAI student council and is operated by the server team of the WIAI student council.

The rewrite started at Bamberger Hackaton 2018 with the Python framework Django. After a long break, a new simple approach could be pursued due to new endpoints in the UnivIS PRG interface, which was implemented with Flask. At the same time an improved UnivIS API was developed, which returns json instead of xml as response type.

Built With

The project was realized with the following modules:

• Flask
• Flask-Caching
• requests
• UnivIS
• univis_api
• roofis_api
• lector_building_api

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To run this project you need to pre install docker with docker-compose

Installation

Production with Docker

1. COPY docker-compose.yml and docker/roofis2/roofis2.env
2. UPDATE envs: Set the correct api Endpoints
3. FIRST START: Run docker-compose up -d
4. CHANGE permissions: Execute docker-compose exec roofis2 sh and chown www:www -R /app/templates/legal (Sorry for that)
5. RESTART the service docker-compose down && docker-compose up -d

Develop with Docker

# TODO

Usage

TODO

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the AGPL License. See LICENSE for more information.

Contact

Michael Götz - [email protected]

Project Link: https://github.com/michigg/roofis2

Acknowledgements

TODO