+ requirements for developers
This commit is contained in:
parent
1ee3769f81
commit
09c5579c22
15
README.md
15
README.md
|
@ -9,9 +9,9 @@ Shadis is a self-hostable platform for video and image uploads from screencaptur
|
|||
|
||||
## Requirements
|
||||
|
||||
This project was built for webspace hosts in mind. These providers usually don't grant shell access, nor do they they allow the installation of additional software. Hence, the minimum requirements for Shadis are the following:
|
||||
This project was built for webspace hosts in mind. These providers usually don't grant shell access, nor do they they allow the installation of additional software. Hence, the minimum requirements for Shadis in production are the following:
|
||||
|
||||
- Apache
|
||||
- Apache HTTP Server
|
||||
- MySQL
|
||||
- PHP
|
||||
- ImageMagick
|
||||
|
@ -25,7 +25,7 @@ Shadis is still _in beta_ and will not be released in form of a pre-compiled pac
|
|||
|
||||
## Generating a production build
|
||||
|
||||
First, download Shadis and its necessary dependencies by following the setup instructions [below](#Setup).
|
||||
First, download Shadis and its necessary dependencies by following the setup instructions [below](#Requirements).
|
||||
You should then be able to compile the code via `yarn build`. Follow the instructions in the console should an error happen while compiling.
|
||||
|
||||
The contents in the `build` directory can then be deployed to a PHP web-server.
|
||||
|
@ -90,6 +90,15 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
|
|||
|
||||
> This guide assumes you use `yarn` as the default package manager
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js (>= 13.5.0)
|
||||
- yarn 1.x (preferred over npm)
|
||||
- Apache HTTP Server
|
||||
- MySQL
|
||||
- PHP
|
||||
- ImageMagick
|
||||
|
||||
## Setup
|
||||
|
||||
Note that this repository uses **_submodules which need to be cloned seperately_**. To achieve this, you can add the following argument when cloning:
|
||||
|
|
Loading…
Reference in New Issue