https://github.com/basster/hs-bremen-web-api
https://github.com/basster/hs-bremen-web-api
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/basster/hs-bremen-web-api
- Owner: Basster
- Created: 2016-01-23T13:08:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-19T16:29:26.000Z (almost 10 years ago)
- Last Synced: 2025-03-30T15:46:59.745Z (about 1 year ago)
- Language: PHP
- Size: 1.88 MB
- Stars: 6
- Watchers: 8
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Web-API | HS-Bremen @ SoSe 2016
## Benötigte Software
- [Git](https://git-scm.com/) (Quellcodeverwaltung)
- [VirtualBox](https://www.virtualbox.org/) (Virtualisierungs Software)
- [Vagrant](https://www.vagrantup.com/) (Automatisierte VM Konfiguration)
- [XAMPP](https://www.apachefriends.org) oder lokale PHP Installation (für lokale Tests [geht auch ohne])
- [Composer](https://getcomposer.org/) PHP Paketmanager (geht auch ohne, über die VM)
- Einen Editor (vorzugsweise PhpStorm)
## Initiales Setup
1. Klone dieses Repository `git clone git@github.com:Basster/hs-bremen-web-api.git`
2. Wechsel in das Verzeichnis `cd hs-bremen-web-api`
3. Starte die VM mit `vagrant up`
4. Warte bis die VM erstellt wurde, währenddessen folgendes, als neue Zeile, in die Datei `C:\Windows\System32\drivers\etc\hosts` bzw. `/etc/hosts/` eintragen (Als Administrator/root bearbeiten):
```
192.168.56.111 web-api.vm
```
5. Wenn die VM fertig gebaut ist, sieht das in etwa so aus:
```
+ Zwei Elefanten +++++++++++ Zwei Elefanten +
+ Viel Text +++++++++++++++++++++ Viel Text +
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
| ____ _ _ _ _ |
| | _ \ ___ __ _ __| | / \ | |__ _____ _____| | |
| | |_) / _ \/ _` |/ _` | / _ \ | '_ \ / _ \ \ / / _ \ | |
| | _ < __/ (_| | (_| | / ___ \| |_) | (_) \ V / __/_| |
| |_| \_\___|\__,_|\__,_| /_/ \_\_.__/ \___/ \_/ \___(_) |
| |
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
```
6. Installiere die erforderlichen PHP Pakete: `composer install` (wenn lokale PHP Installation, sonst unter `/var/www/sources` per SSH auf der VM)
7. Browser öffnen und `http://web-api.vm/` eingeben.
8. Das `hs-bremen-web-api` Verzeichnis im Editor deiner Wahl öffnen.
## Vor jeder Session
1. `vagrant up` (dauert jetzt nicht mehr so lange)
## Nach jeder Session
1. `vagrant halt` (fährt die VM runter)
## Per SSH auf die VM
Host: localhost
Port: 2222
User: vagrant
Private-Key: `./puphpet/files/dot/ssh/id_rsa`
Kein Password
### Was ist auf der VM installiert?
- Ubuntu 14.04 LTS x64 (1 CPU, 512 MB RAM)
- IP: 192.168.56.111
- Offene Ports: TCP 9000 (xDebug) und TCP 3306 (MySQL)
- vim, htop
- nginx
- PHP 5.6
- Nodejs 5
- MariaDB 10.1 (user: root, pw: 123)
## Testen
```
cd sources
php vendor/bin/phpunit -c phpunit.xml.dist
```
oder über die IDE
## Swagger UI Standalone
https://github.com/swagger-api/swagger-ui#build
Benötigt npm und python!
- npm install
- npm run serve
- Browser: http://localhost:8080/
TODO: PhpStorm Setup beschreiben!