Finale README.md Anleitung
This commit is contained in:
154
README.md
154
README.md
@@ -1,93 +1,127 @@
|
||||
# SWE-B1-A
|
||||
# Projektbeschreibung
|
||||
|
||||
Dieses Projekt ist eine PHP-Webseite, die Schülerinnen und Schülern ermöglicht, Hausaufgaben und Übungsblätter herunterzuladen. Die Webseite ist unabhängig von einem bestimmten Webserver und kann mit jedem Server konfiguriert werden, der PHP unterstützt.
|
||||
|
||||
## Anforderungen
|
||||
|
||||
## Getting started
|
||||
Um die Webseite auszuführen, benötigen Sie:
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
- **Webserver**: Jeder Webserver, der PHP unterstützt (z. B. Apache, Nginx, IIS).
|
||||
- **PHP**: Version 7.4 oder höher.
|
||||
- **Dateisystem**: Schreibzugriff auf das Verzeichnis, in dem die Webseite gehostet wird.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
## Einrichtung
|
||||
|
||||
## Add your files
|
||||
### 1. Projektdateien bereitstellen
|
||||
- Extrahieren Sie die Projektdateien aus dem Ordner `webseite` aus dem bereitgestellten Archiv.
|
||||
- Platzieren Sie die Dateien in einem Verzeichnis, das der Webserver bedienen kann.
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
### 2. PHP aktivieren
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.fh-aachen.de/eb2342s/swe-b1-a.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
#### a) Apache
|
||||
- Stellen Sie sicher, dass das Modul `mod_php` aktiviert ist.
|
||||
- Überprüfen Sie die Apache-Konfigurationsdatei (z. B. `httpd.conf`), und stellen Sie sicher, dass PHP korrekt eingebunden ist:
|
||||
|
||||
## Integrate with your tools
|
||||
```apache
|
||||
LoadModule php_module modules/libphp.so
|
||||
AddType application/x-httpd-php .php
|
||||
```
|
||||
|
||||
- [ ] [Set up project integrations](https://git.fh-aachen.de/eb2342s/swe-b1-a/-/settings/integrations)
|
||||
#### b) Nginx
|
||||
- Stellen Sie sicher, dass PHP-FPM installiert und aktiviert ist.
|
||||
- Fügen Sie in der Nginx-Konfigurationsdatei (`nginx.conf`) einen Block für PHP-Dateien hinzu:
|
||||
|
||||
## Collaborate with your team
|
||||
```nginx
|
||||
location ~ \.php$ {
|
||||
include fastcgi_params;
|
||||
fastcgi_pass 127.0.0.1:9000;
|
||||
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
#### c) IIS (Windows)
|
||||
- Installieren Sie PHP mit dem Microsoft Web Platform Installer.
|
||||
- Stellen Sie sicher, dass die Handlerzuordnung für `.php`-Dateien auf den PHP-Interpreter verweist.
|
||||
|
||||
## Test and Deploy
|
||||
### 3. Webseite konfigurieren
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
#### Projektdateien ins Webserver-Verzeichnis kopieren:
|
||||
- Platzieren Sie den gesamten Inhalt des Ordners `webseite` mit dem Quellcode der Webseite in das Hauptverzeichnis Ihres Webservers:
|
||||
- **Apache**: Kopieren Sie die Dateien in das `htdocs`-Verzeichnis (z. B. `C:\xampp\htdocs\mein-projekt`).
|
||||
- **Nginx**: Platzieren Sie die Dateien im Root-Verzeichnis, das in Ihrer Konfiguration definiert ist (z. B. `/usr/share/nginx/html`).
|
||||
- **IIS**: Legen Sie die Dateien in das Verzeichnis der zugehörigen IIS-Site (z. B. `C:\inetpub\wwwroot`).
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
#### Caching aktivieren (empfohlen):
|
||||
|
||||
***
|
||||
- **Apache**: Aktivieren Sie das Modul `mod_expires` und fügen Sie folgende Regeln zur `.htaccess`-Datei im Projektordner hinzu:
|
||||
|
||||
# Editing this README
|
||||
```apache
|
||||
<IfModule mod_expires.c>
|
||||
ExpiresActive On
|
||||
ExpiresByType text/html "access plus 1 hour"
|
||||
ExpiresByType image/gif "access plus 1 week"
|
||||
ExpiresByType image/jpeg "access plus 1 week"
|
||||
ExpiresByType image/png "access plus 1 week"
|
||||
ExpiresByType text/css "access plus 1 week"
|
||||
ExpiresByType text/javascript "access plus 1 week"
|
||||
ExpiresByType application/javascript "access plus 1 week"
|
||||
</IfModule>
|
||||
```
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
- **Nginx**: Fügen Sie der Nginx-Konfigurationsdatei folgendes hinzu:
|
||||
|
||||
## Suggestions for a good README
|
||||
```nginx
|
||||
location ~* \.(jpg|jpeg|png|gif|css|js|ico|html)$ {
|
||||
expires 7d;
|
||||
add_header Cache-Control "public, max-age=604800";
|
||||
}
|
||||
```
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
### 4. Berechtigungen setzen
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
- Stellen Sie sicher, dass der Webserver die erforderlichen Berechtigungen für das Verzeichnis hat, in dem die Webseite liegt:
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
**Linux**:
|
||||
```bash
|
||||
chmod -R 755 /pfad/zum/webverzeichnis
|
||||
chown -R www-data:www-data /pfad/zum/webverzeichnis
|
||||
```
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
**Windows**:
|
||||
- Überprüfen Sie die Sicherheitseinstellungen des Ordners und geben Sie dem Benutzerkonto des Webservers (z. B. `IUSR`) Lese- und Ausführungsrechte.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
### 5. Webseite aufrufen
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
- **Domain oder IP-Adresse öffnen**:
|
||||
- Rufen Sie die Webseite mit dem zugewiesenen Domainnamen oder der IP-Adresse auf. Beispiel:
|
||||
- `http://localhost`
|
||||
- `http://ihre-domain.de`
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
- **Indexseite testen**:
|
||||
- Die Startseite der Webseite sollte automatisch geladen werden (z. B. `index.php`).
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
## Fehlerbehebung
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
- **500 Internal Server Error**:
|
||||
- Überprüfen Sie die PHP-Fehlerprotokolle, um die genaue Ursache zu finden.
|
||||
- **404 Not Found**:
|
||||
- Stellen Sie sicher, dass die Dateien im richtigen Verzeichnis liegen und die Datei `index.php` vorhanden ist.
|
||||
- **PHP-Funktionalität überprüfen**:
|
||||
- Erstellen Sie eine Datei namens `info.php` mit folgendem Inhalt:
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
```php
|
||||
<?php
|
||||
phpinfo();
|
||||
?>
|
||||
```
|
||||
- Rufen Sie die Datei im Browser auf, um zu überprüfen, ob PHP korrekt funktioniert.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
## Zusätzliche Hinweise
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
- Diese Anleitung ist bewusst allgemein gehalten, um mit verschiedenen Serverumgebungen kompatibel zu sein.
|
||||
- Für die Bereitstellung in einer Produktionsumgebung sollten zusätzliche Sicherheitsmaßnahmen getroffen werden (z. B. HTTPS, Rechteverwaltung, Zugriffsbeschränkungen).
|
||||
- Wir empfehlen, relativ aggressives Caching zu aktivieren, um unnötige Last durch ausgeführtes PHP zu verhindern.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
## Kontakt
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
Falls Sie Fragen oder Probleme haben, wenden Sie sich bitte an das Entwicklerteam.
|
||||
Reference in New Issue
Block a user