Skip to content
This repository was archived by the owner on Mar 29, 2024. It is now read-only.

Commit 9ac4e70

Browse files
committed
Update README
1 parent 18c7f29 commit 9ac4e70

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
11
# TempFiles Backend
22
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Carlgo11/Tempfiles-backend/Test%20PHPUnit?style=for-the-badge)](https://github.com/Carlgo11/Tempfiles-backend/actions)
3+
[![GitHub](https://img.shields.io/github/license/carlgo11/tempfiles-backend?style=for-the-badge)](https://github.com/Carlgo11/TempFiles-backend/blob/master/LICENSE)
4+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/carlgo11/tempfiles-backend?style=for-the-badge)](https://github.com/Carlgo11/TempFiles-backend/releases)
35

46
## API calls :mega:
57
A list of available API calls can be found over at [Postman](https://documenter.getpostman.com/view/1675224/SW7ezkZn).
68

7-
## Local installation :desktop_computer:
9+
## Contributing :writing_hand:
810

9-
1. Install PHP, Nginx, Git
11+
To edit the TempFiles-Backend code you need:
12+
* An IDE/Editor that supports [EditorConfig](https://editorconfig.org/#download).
13+
* Composer
14+
* PHP 7.2 (Or later)
15+
* PHP extensions: curl, xsl, mbstring
16+
17+
To install all dependencies, run the following command:
18+
```BASH
19+
composer install
20+
```
21+
22+
## Deployment :desktop_computer:
23+
24+
1. Install PHP, Nginx, Git, Composer
1025
```BASH
1126
sudo apt update
1227
sudo apt upgrade
13-
sudo apt install nginx php php-fpm php-curl php-mbstring git
28+
sudo apt install nginx php php-fpm composer php-curl php-mbstring git
1429
```
1530

1631
2. Download the source code
@@ -19,7 +34,12 @@ A list of available API calls can be found over at [Postman](https://documenter.
1934
cd Tempfiles-backend/
2035
```
2136

22-
3. Set file path
37+
3. Download dependencies
38+
```BASH
39+
composer install --no-dev
40+
```
41+
42+
4. Set file path
2343
```BASH
2444
nano src/com/carlgo11/tempfiles/config.php
2545
```
@@ -30,12 +50,12 @@ A list of available API calls can be found over at [Postman](https://documenter.
3050
chmod 0700 /tempfiles -R
3151
```
3252

33-
4. Copy the Nginx configurations to the sites-available directory.
53+
5. Copy the Nginx configurations to the sites-available directory.
3454
```BASH
3555
cp ./ressouces/nginx/*.conf > /etc/nginx/sites-available/
3656
```
3757

38-
5. Generate certificates.
58+
6. Generate certificates.
3959
For HTTPS to work you'll need a certificate. Due to the many different certificate companies and their different ways of generating certificates I won't go into that in this text.
4060
When you have a certificate, change the following lines in both nginx configs:
4161
```BASH
@@ -46,7 +66,7 @@ A list of available API calls can be found over at [Postman](https://documenter.
4666
ssl_certificate_key {path_to_key}/privkey.pem; #Change path
4767
```
4868

49-
6. Restart Nginx
69+
7. Restart Nginx
5070
```BASH
5171
sudo systemctl restart nginx
5272
```

0 commit comments

Comments
 (0)