phundrak
/
phundrak.com
1
0
Fork 0
Code Issues Pull Requests Actions Activity
Repository for my main website https://phundrak.com
19 Commits 2 Branches 0 Tags 924 KiB
TypeScript 36.6%
Vue 31.6%
SCSS 16.7%
Less 9.7%
Emacs Lisp 4.6%
Other 0.8%
Go to file
Lucien Cartier-Tilet 7f217641f0
feat(backend): add initial backend 
Backend as is can query GitHub for the information that will be
necessary later on in the frontend's pages. It does not cache this
information yet though.

Signed-off-by: Lucien Cartier-Tilet <lucien@phundrak.com>
 		2023-02-09 12:13:51 +01:00
content refactor: move Vuepress files in dedicated directory 2023-02-09 12:13:47 +01:00
src feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
.drone.yml refactor: move Vuepress files in dedicated directory 2023-02-09 12:13:47 +01:00
.env.example feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
.gitignore feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
Cargo.lock feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
Cargo.toml feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
Dockerfile feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
LICENSE.md feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
README.org feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
docker-compose.yml feat(backend): add initial backend 2023-02-09 12:13:51 +01:00
package.json refactor: move Vuepress files in dedicated directory 2023-02-09 12:13:47 +01:00
yarn.lock feat: remove HTML extensions from links 2023-02-09 12:13:23 +01:00

README.org

phundrak.com

Introduction

This is the repository for my website phundrak.com. While it is not yet live on this address, development versions can be found at alpha.phundrak.com and beta.phundrak.com (the former follows the develop branch while the latter follows the master branch).

Structure of the project

Frontend

The frontend is made with VuePress, a Vue-powered static site generator. You can find its Node.JS configuration in the package.json file as well as its content and general configuration in the directory content.

Installing and running

To install the NPM dependencies for the project, run one of the following commands:

yarn
# or
npm install # delete the yarn.lock file before

To run the project, run one of the following commands using the same package manager as above:

yarn dev
# or
npm run dev

You can compile the website to a static website by running

yarn build
# or
npm run build

The compiled version of the website can then be found in content/.vuepress/dist.

Backend

This is a simple backend server written in Rust, offering a REST API at the address https://phundrak.com/api/v1. It communicates with a Redis instance in order to cache some queries the frontend makes.

Installing and running

The currently preferred way of running the project is through docker-compose using these commands:

docker-compose pull # retrieve the necessary images (optional)
docker-compose build
docker-compose up # add option -d to detach immediately
docker-compose down # to stop the container if you detached it previously