diff --git a/README.md b/README.md index 1252ec5..2ea7d71 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # vlw.se -This is the source code behind [vlw.se](https://vlw.se) which has been written from the ground up by me. This website is built on top of my [Vegvisir web framework](https://github.com/victorwesterlund/vegvisir) and my [Reflect API framework](https://github.com/victorwesterlund/reflect). +This is the source code behind [vlw.se](https://vlw.se) which has been written from the ground up by me. This website is built on top of my [Vegvisir web framework](https://vegvisir.vlw.se) and my [Reflect API framework](https://reflect.vlw.se). # Installation If you for whatever reason want to get this website up and running for yourself this is how that is done. @@ -9,18 +9,18 @@ This website is built for PHP 8.0+ and MariaDB 14+ (for the API database). **Confimed supported framework versions:** Vegvisir|Reflect --|-- -✅ [`2.5.0`](https://github.com/VictorWesterlund/vegvisir/releases/tag/2.5.0)|✅ [`2.7.2`](https://github.com/VictorWesterlund/reflect/releases/tag/2.7.2) +✅ [`3.0.1`](https://codeberg.org/vegvisir/vegvisir/releases/tag/3.0.1)|✅ [`2.7.2`](https://codeberg.org/reflect/reflect/releases/tag/2.7.2) ## Website (Vegvisir) 1. **Download this repo** Git clone or download this repo to any local folder ``` - git clone https://github.com/VictorWesterlund/vlw.se + git clone https://codeberg.org/vlw/vlw.se ``` 2. **Download and install Vegvisir** - Follow the installation instructions for [Vegvisir](https://github.com/victorwesterlund/vegvisir) and point the `site_path` variable to the local vlw.se folder. + Follow the installation instructions for [Vegvisir](https://vegvisir.vlw.se/docs/installation) and point the `site_path` variable to the local vlw.se folder. 3. **Install dependencies** @@ -40,12 +40,12 @@ The API (and database) is where most content is stored and served from on this w Otherwise... Git clone or download this repo to any local folder ``` - git clone https://github.com/VictorWesterlund/vlw.se + git clone https://codeberg.org/vlw/vlw.se ``` 2. **Download and install Reflect** - Follow the installation instructions for [Reflect](https://github.com/victorwesterlund/vegvisir) and point the `endpoints` variable to the `/api` subdirectory in the local vlw.se folder. + Follow the installation instructions for [Reflect](https://reflect.vlw.se/docs/installation) and point the `endpoints` variable to the `/api` subdirectory in the local vlw.se folder. 3. **Install dependencies** @@ -62,9 +62,6 @@ The API (and database) is where most content is stored and served from on this w Make a copy of `/api/.env.example.ini` and change the `[vlwdb]` variables with your MariaDB credentials. - You also have to generate a [GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) if you wish to use the `releases` endpoint. - [Read more about this endpoint here](#) - 6. **Set environment variables for website** It's reasonable to assume if you've installed the website from this repo that you'd also want to use the API with it. Start my making a copy of `/.env.example.ini` (root directory) and change the `[api]` variables to point to your API hostname.