https://github.com/michigg/roofis2

Flask rewrite of the famous RooFiS Service
https://github.com/michigg/roofis2

flask roofis

Last synced: 2 months ago
JSON representation

Flask rewrite of the famous RooFiS Service

• Host: GitHub
• URL: https://github.com/michigg/roofis2
• Owner: michigg
• License: agpl-3.0
• Created: 2019-09-25T22:40:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T07:58:38.000Z (over 3 years ago)
• Last Synced: 2023-03-03T13:51:23.962Z (over 3 years ago)
• Topics: flask, roofis
• Language: Vue
• Homepage:
• Size: 12.4 MB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


![Drone (self-hosted)](https://img.shields.io/drone/build/michigg/roofis2?server=https%3A%2F%2Fdrone.github.michigg.de&style=for-the-badge)

[![Contributors](https://img.shields.io/github/contributors/michigg/roofis2.svg?style=for-the-badge)](https://github.com/michigg/roofis2)

[![Forks](https://img.shields.io/github/forks/michigg/roofis2.svg?style=for-the-badge)](https://github.com/michigg/roofis2)

[![Stars](https://img.shields.io/github/stars/michigg/roofis2.svg?style=for-the-badge)](https://github.com/michigg/roofis2)

[![Issues](https://img.shields.io/github/issues/michigg/roofis2.svg?style=for-the-badge)](https://github.com/michigg/roofis2)

[![License](https://img.shields.io/github/license/michigg/roofis2.svg?style=for-the-badge)](https://github.com/michigg/roofis2)






  
RooFiS 2


  


    Room Finding Service Version 2.0

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  


## Table of Contents

* [About the Project](#about-the-project)

  * [Built With](#built-with)

* [Getting Started](#getting-started)

  * [Prerequisites](#prerequisites)

  * [Installation](#installation)

* [Usage](#usage)

* [Roadmap](#roadmap)

* [Contributing](#contributing)

* [License](#license)

* [Contact](#contact)

* [Acknowledgements](#acknowledgements)

## About The Project

![RooFiS Screen Shot](https://raw.githubusercontent.com/michigg/roofis2/master/RooFiS_2_demo.png)

"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](https://github.com/michigg/univis_api)). 

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](http://www.config.de/cgi-bin/prg-wizard.pl), 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](https://github.com/pallets/flask)

* [Flask-Caching](https://github.com/sh4nks/flask-caching)

* [requests](https://requests.kennethreitz.org/en/master/)

* [UnivIS](https://http://univis.uni-bamberg.de/)

* [univis_api](https://github.com/michigg/univis_api)

* [roofis_api](https://github.com/michigg/roofis2_api)

* [lector_building_api](https://github.com/michigg/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](https://docs.docker.com/v17.09/engine/installation/) with [docker-compose](https://docs.docker.com/compose/install/)

### 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](https://github.com/michigg/roofis2/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 - michael-guenther.goetz@stud.uni-bamberg.de

Project Link: [https://github.com/michigg/roofis2](https://github.com/michigg/roofis2)

## Acknowledgements

 `TODO`

[product-screenshot]: images/demo.png