readme.md 1.67 KB
Newer Older
Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
1
# mensa-app
unknown's avatar
unknown committed
2

Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
3
Informiere dich über aktuelle Gerichte der Mensen in Münster, verabrede dich zum Essen mit deinen Freunden und werde benachrichtigt, wenn dein Lieblingsgericht serviert wird.
unknown's avatar
unknown committed
4

Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
5
## Entwicklung
unknown's avatar
unknown committed
6
7

Die Anwendung kannn entweder lokal, oder mit Docker entwickelt werden.
Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
8
9

### Entwicklung ohne Docker
unknown's avatar
unknown committed
10
11
12

Wenn ohne Docker entwickelt wird muss das Frontend und das Backend separat gestartet werden.

13
#### Frontend
unknown's avatar
unknown committed
14

15
16
17
- `cd client`
- `npm install`
- `npm start`
Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
18
- Das Frontend ist jetzt unter https://localhost:8080/ erreichbar.
unknown's avatar
unknown committed
19

20
#### Backend
21
22

**Umgebungsvariablen**  
Niclas Schnickmann's avatar
Niclas Schnickmann committed
23
Es sollte die Umgebungsvariable `URL` auf die Domain des Backends gesetzt werden. Für die lokale Entwicklung wäre dies `localhost:3443`. Dadurch werden die URLs des Image Service korrekt umgeschrieben. Dies ist notwendig, damit diese über den express-proxy des backends laufen. So kann der JWT inkludiert, und CORS Schwierigkeiten ([Safari blockiert alle Cross-Resource Cookies](https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/)) umgangen werden.
unknown's avatar
unknown committed
24

25
26
- `cd server`
- `npm install`
Niclas Schnickmann's avatar
Niclas Schnickmann committed
27
- `export URL="localhost:3443"`
unknown's avatar
unknown committed
28
- `npm run watch:dev` Alternativ kann die Produktionsdatenbank mit `npm run watch:prod` angesteuert werden.
29
30
- Das Backend wartet unter http://localhost:3443/app/ auf Anfragen.

Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
31
### Entwicklung mit Docker
unknown's avatar
unknown committed
32

Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
33
34
35
36
1. `docker-compose up`
2. Frontend und Backend sind unter den oben genannten Adressen verfügbar.

## Deployment und Hosting
unknown's avatar
unknown committed
37

Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
38
Der neuste Stand der Anwendung wird bei jedem push in diesem Repository live geschaltet.
Felix Schulze Sindern's avatar
Felix Schulze Sindern committed
39
Das Backend wird auf DigitalOcean's app platform gehostet, das Frontend wird mit Github pages bereitgestellt und ist unter https://mensa-app.dub-services.de/mensa-app/ erreichbar.