eolas-app/README.md

1.3 KiB

eolas-app

A React web app that serves as the frontend for my Zettelkasten, Eolas.

eolas-app is a constituent part of my knowledge management system comprising eolas, eolas-db, and eolas-api.

It sources its data from eolas-api also running on my VPS.

Local development

npm install
npm run dev

This will use Vite to start the application at http://localhost:5173. The application requires a local instance of eolas-api to be running, specified via the environment variable VITE_EOLAS_API_ENDPOINT in a .env.

Alternatively use the production API URL.

Deployment

The application is deployed to my remote VPS, residing at /var/www/eolas-app.

It is publicly accessible at eolas.systemsobscure.net.

Deployment is automated via a Forgejo action that builds the Webpack bundle and transfers it to the VPS. Deployment actions are always executed by the deploy user on the VPS.