thohlt/archtika
1
0
Fork 0
mirror of https://github.com/thiloho/archtika.git synced 2025-11-22 02:41:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Thilo Hohlt
2024-12-13 16:51:29 +01:00
committed by GitHub
parent 420da199f1
commit 572c0924b1
1 changed files with 2 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -4,29 +4,6 @@
archtika is a FLOSS, modern, performant, lightweight and self-hosted CMS (Content Mangement System) in the form of a web application. It allows you to easily create, manage and publish minimal, responsive and SEO friendly blogging and documentation websites using the templates provided. Contributors can also be added to a website, allowing multiple people to work on a project.
## How it works
## Preview
For the backend, PostgreSQL is used in combination with PostgREST to create a RESTful API. JSON web tokens along with row-level security control authentication and authorisation flows.
The web application uses SvelteKit with SSR (Server Side Rendering) and Svelte version 5.
NGINX is used to deploy the websites, serving the static website files from the `/var/www/archtika-websites` directory. The website files are generated and written to this directory by the web application on the server side for preview and publishing.
## Virtual machine for local development
The website directory used by the virtual machine needs to be created and the NodeJS process, which typically runs as the default system user, needs permission to write to this directory.
This can be achieved using the following commands:
```bash
sudo mkdir -p /var/www/archtika-websites
```
```bash
sudo chown $USER:$(id -gn) /var/www/archtika-websites
```
```bash
nix run .#dev-vm
```
[archtika-video-preview.webm](https://github.com/user-attachments/assets/7a43931c-6d9e-484a-8238-29e3d9bfb603)