Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/larsniet/hsl-collegekaart
Een makkelijke manier voor alle studenten van de Hogeschool Leiden om altijd hun collegekaart bij de hand te hebben.
https://github.com/larsniet/hsl-collegekaart
Last synced: 2 months ago
JSON representation
Een makkelijke manier voor alle studenten van de Hogeschool Leiden om altijd hun collegekaart bij de hand te hebben.
- Host: GitHub
- URL: https://github.com/larsniet/hsl-collegekaart
- Owner: larsniet
- License: gpl-3.0
- Created: 2021-04-28T20:33:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T22:40:02.000Z (almost 2 years ago)
- Last Synced: 2023-03-06T09:58:19.442Z (almost 2 years ago)
- Language: PHP
- Homepage:
- Size: 848 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hogeschool Leiden Collegekaart App Android
## :construction_worker: Technieken
## :memo: Beschrijving
Elke student heeft er wel eens last van (gehad), je hebt op juist dat ene moment dat je het niet verwacht je collegekaart nodig. Tja, je zou naar huis kunnen fietsen maar dan is het waarschijnlijk al te laat. Deze app brengt daar verandering in. Je logt in met je eigen Hogeschool Leiden account en je gegevens worden automatisch opgehaald. Deze gegevens gebruikt de app om vervolgens jouw collegekaart na te maken in de app. Nadat je bent ingelogd kan je met 1 klik op de app meteen je collegekaart tevoorschijn halen en je barcode laten scannen.
## :information_source: Uitleg
Deze repository bestaat uit 2 onderdelen. De backend (gebouwd in Laravel) en de frontend (gebouwd in Android). Voor het ontwikkelen van de Laravel applicatie heb ik gebruik gemaakt van een Digital Ocean server waar Ubuntu op staat. Voor het ontwikkelen van de Android applicatie heb ik gebruikt gemaakt van Android Studio en zowel fysieke apparaten als emulators om te testen.
## :calling: Installatie
Gebruik [git](https://github.com/git/git) om deze repository te clonen.
```bash
git clone https://github.com/larsniet/HSL-Collegekaart.git
```
### Opzetten van de Laravel omgeving
Bij het opzetten van de Laravel omgeving ga ik ervan uit dat de benodigde software geïnstalleerd is op de host. Denk hierbij bijvoorbeeld aan Composer, PHP en MySQL.
Begin met het aanpassen van de database gegevens in het .env bestand naar jouw eigen gegevens (in mijn geval MySQL). Vervolgens kan je de volgende commands uitvoeren:
```bash
cd ./HSL-Collegekaart/laravel
composer install # Installeerd alle dependencies
php artisan key:generate # Maakt unieke key aan in het .env bestand
php aritsan migrate:fresh --seed # Haalt de database die is ingevoerd in het .env bestand leeg en vult deze met de benodigde data
php artisan serve --host={host ip-adres} # Start de laravel applicatie lokaal
php artisan jwt:secret # Maakt JWT secret aan
```
### Opzetten van de Android applicatie
- Open de **android** map in Android Studio.
- Wacht tot het downloaden van de dependencies en het builden van de gradle files compleet is.
- Navigeer naar **HSL-Collegekaart\android\app\src\main\res\raw**, hier staat een MSAL-config bestand in als voorbeeld. Om te voorkomen dat iedereen zomaar toegang heeft tot de inlogmethode van de Hogeschool Leiden wordt het werkende bestand met gevoelige gegevens niet meegestuurd. Vul alle gegevens in zoals ze in de example MSAL-config (maar dan met je eigen gegevens) staan en vernoem het bestand naar **msal_config.json**.
- Sla vervolgens het stukje vanaf de laatste '/' van de redirect_uri op, deze heb je nodig voor het bestand **AndroidManifest.xml**.
- Navigeer naar **HSL-Collegekaart\android\app\src\main\AndroidManifest.xml** en ga op zoek naar de data reference (er is er maar 1).
- Vul bij **android:path** het laatste stukje van de redirect_uri in.
- In verband met problemen door lokale hosting moet het bestand **HSL-Collegekaart\android\app\src\main\res\xml\network_security_config.xml** gevuld worden met het ip-adres van de host, anders kan de Android applicatie geen verbinding maken met de (lokale) Laravel applicatie.
- Vervolgens kies je een emulator/fysiek apparaat en kan je de app runnen.
Voor meer uitleg, zie de documentatie van [MSAL](https://docs.microsoft.com/nl-nl/azure/active-directory/develop/msal-configuration).
## :hearts: Bijdragen
Pull requests zijn welkom. Voor grote veranderingen, open eerst een issue om ze te bespreken.
## :copyright: License
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)