Skip to content

mate-app/mate_fhkiel_validateuserdata

Repository files navigation

FH Kiel User Validation Cloud Function for the Official mate App.

GitHub tag (latest by date) Issues Contributors License

Key FeaturesHow To UseCreditsLicense

Key Features

  • verifies FH Kiel students for the mate app
  • sends POST request to the website of FH Kiel
    • grabs cookies and then verifies the legitimacy
  • fully tested and documented code
  • CI for automatic coverage report
  • CD for deployment on push to master to dev-project and on new tag to production-project

How To Use

To clone and run this application, you'll need Git and Python installed on your computer. It is tested with Python 3.8. Then from your command line run:

# Clone this repository
$ git clone https://github.com/TobiasPrt/mate_fhkiel_validateuserdata

# Go into the repository
$ cd mate_fhkiel_validateuserdata

# Create virtual environment
$ python3 -m venv env

# Start virtual environment
$ source env/bin/activate

# Install dependencies from requirements
$ pip install -r requirements.txt

# Make sure everything is working
$ py.test

# Use functions-framework for python to test and debug locally
$ functions-framework --target=validate_user_data

The function is now available on http://localhost:8080.

Credits

This function specifically uses the following open source packages:

License

MIT


mate-app.de  ·  Instagram @officialmateapp  ·  Twitter @officialmateapp