mirror of
https://codeberg.org/vlw/vlw.se.git
synced 2025-09-13 21:13:40 +02:00
vlw
f76962e2ac
This PR replaces the database files from Release with VCS in git Reviewed-on: https://codeberg.org/vlw/vlw.se/pulls/29 Co-authored-by: vlw <victor@vlw.se> Co-committed-by: vlw <victor@vlw.se>
67 lines
No EOL
2.6 KiB
Markdown
67 lines
No EOL
2.6 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 [web framework](https://vegvisir.vlw.se) and its API is also built on top of my own [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 later is written in bash.
|
|
|
|
**Make sure you have both of these package managers installed before proceeding:**
|
|
- [Composer](https://getcomposer.org/)
|
|
- [NPM](https://www.npmjs.com/)
|
|
|
|
## 1. Clone this repo
|
|
Clone/download this repo to your machine. Preferably to a non-public directory - the frameworks will handle that.
|
|
|
|
```
|
|
git clone https://codeberg.org/vlw/vlw.se --depth 1
|
|
```
|
|
|
|
## 2. Install [Vegvisir](https://vegvisir.vlw.se) and [Reflect](https://reflect.vlw.se)
|
|
Follow the installation instructions for my web, and API framework. This site uses the default configuration for both frameworks so the only thing you need to do after you've installed both is to point the `root_path` and `endpoints` directory respectively to the directory where you cloned this repo.
|
|
|
|
- [Vegvisir installation](https://vegvisir.vlw.se)
|
|
- [Reflect installation](https://reflect.vlw.se)
|
|
|
|
*Example:*
|
|
```sh
|
|
# Vegvisir
|
|
root_path = "/var/www/vlw.se"
|
|
# Reflect
|
|
endpoints = "/var/www/vlw.se"
|
|
```
|
|
|
|
## 3. Run the install script
|
|
Run the `install.sh` script from the root of the repo directory. [Make sure you have the required package managers installed](#installation).
|
|
|
|
**Example:**
|
|
```sh
|
|
# vlw@example:$
|
|
cd /var/www/vlw.se
|
|
# vlw@example:/var/www/vlw.se$
|
|
./install.sh
|
|
```
|
|
|
|
## 4. Import the database templates
|
|
There's are two SQL files in [`/src/Database/Seeds/`](https://codeberg.org/vlw/vlw.se/src/branch/master/src/Database/Seeds) that you can use to initialize the two databases required for this website.
|
|
|
|
- `vlw` - This database has the website data and should be added to the `db` variable under `server_database` in `/.env.ini`
|
|
- `vlw_reflect` - This is the Reflect database that has all the endpoints pre-configured. You'll have to add your own ACL rules.
|
|
|
|
## 5. Set environment variables
|
|
Make a copy of the `.env.example.ini` file called `.env.ini` from the root directory of the repo. There are a few parameters you can change here but the required ones are the following:
|
|
|
|
```ini
|
|
[client_api]
|
|
base_url = ""
|
|
api_key = ""
|
|
|
|
[server_database]
|
|
host = ""
|
|
user = ""
|
|
pass = ""
|
|
db = ""
|
|
```
|
|
|
|
Please refer to the comments in the ini file for more information about each field.
|
|
|
|
## Done!
|
|
That should be it. Navigate to your configured Vegvisir public host! |