MyCargonaut

MyCargonaut ist ein Projekt im Rahmen des KmS-Praktikums im WS20/21.

Technologien

• ReactJS
• Redux
• Material-UI
• NestJS

Development

Frontend

• In den frontend-Ordner wechseln: cd frontend
• Benötigte Module installieren: npm i
• _Development-Server starten: npm run start

Backend

• In den backend-Ordner wechseln: cd backend
• Datenbank starten: npm run db:start
• Benötigte Module installieren: npm i
• Development-Server starten: npm run start:dev

Demo

Eine Demo der App befindet sich hier: Heroku

Dokumentation

Für die Dokumentation wird mkdocs-material verwendet.

Lokal starten

Linux

• requirements installieren: sudo pip3 install -r docs/requirements.txt
• mkdocs-material starten: mkdocs serve

Windows

• requirements installieren: pip install -r docs/requirements.txt
• mkdocs-material starten: mkdocs serve

sollte der Port 8000 belegt sein, so kann das Pragramm auf einem anderen gestartet werden: mkdocs serve --dev-addr 127.0.0.1:port