vlw.se/README.md

27 lines
No EOL
1.2 KiB
Markdown

# vlw.se
This is the source code behind [vlw.se](https://vlw.se) which is my personal website that I have written and designed from the ground up. The website is built on top of my own [Vegvisir web framework](https://vegvisir.vlw.se) and its optional REST API is built on top of my [Reflect API framework](https://reflect.vlw.se).
# Installation
Here's how you get my website up and running on your own machine. Note, I have only tested this on Linux and the install script we will run requires Bash with `coreutils` installed.
## Prerequisites
- A web server
- A MariaDB/MySQL server
- PHP 8.4 or newer with the following extensions enabled:
- - `php8.4-mysql`
- - `php8.4-mbstring`
- The composer package manager
- Bash with `coreutils` installed (for the install script)
## 1. Clone this repo
Clone this repository with its submodules. Preferably to a non-public directory - the frameworks will handle that.
```
git clone https://codeberg.org/vlw/vlw.se --recurse-submodules --depth 1
```
## 2. Run the install script
Run the `install.sh` script from the root directory of this repository.
```
./install.sh
```
This script will install and configure Vegvisir, Reflect, and the website through a few propmpted steps.