annaaurora
/
kaufkauflist
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
A to-do list for shopping or other use cases https://kaufkauflist.annaaurora.eu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 Commits
1 Branch
3 Tags
545 KiB
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
Anna Aurora 9625f13b67
Merged collections users and lists. 		2 months ago
src Merged collections users and lists. 2 months ago
static Added pixel art Favicon. 4 months ago
static-src Added pixel art Favicon. 4 months ago
.eslintignore Init project with config files and basic functionality of the app. 4 months ago
.eslintrc.cjs Init project with config files and basic functionality of the app. 4 months ago
.gitignore Added database folder not made to be commited to gitingnore. 3 months ago
.npmrc Init project with config files and basic functionality of the app. 4 months ago
.prettierignore Init project with config files and basic functionality of the app. 4 months ago
.prettierrc Init project with config files and basic functionality of the app. 4 months ago
Caddyfile Improved and fixed Caddyfile. 2 months ago
LICENSE Remove deprecated stuff from Caddyfile, add comments and improve caching. 2 months ago
README.md Ran `npm run format`. 2 months ago
jsconfig.json Init project with config files and basic functionality of the app. 4 months ago
package-lock.json Gave dependencies an upgrade and removed duplicated dependencies. 2 months ago
package.json Gave dependencies an upgrade and removed duplicated dependencies. 2 months ago
pb_schema.json Merged collections users and lists. 2 months ago
shell.nix Added documentation to readme. 2 months ago
svelte.config.js Now building to HTML files etc. and Caddy as dev webserver. 4 months ago
vite.config.js Init project with config files and basic functionality of the app. 4 months ago

README.md
Escape

kaufkauflist /kaʊ̯fkaʊ̯flɪst/

The following instructions are catered to people using the Nix package manager. You will need to have Nix installed or install the dependencies with a different package manager.

First of all, in this project's directory open it's Nix shell (with the development dependencies of this project) with

nix-shell

The following sections will have commands to be run in this shell.

Building

This will install the dependencies required for building:

npm install

This will build the HTML files, etc. into the build directory:

npm run build

Running

Development

Web server

To run the web server (Caddy) while developing (The web server will only be able to serve files if you build before.):

caddy run

Database

It won't quite work without also starting the database (PocketBase):

pocketbase serve

though.

On first start, PocketBase will need to be set up:

  1. Go to http://localhost:8090/_/ (PocketBase's web interface) and create an admin account.
  2. Under http://localhost:8090/_/#/settings/import-collections, import pb_schema.json.

Production

Install kaufkauflist from nixpkgs to get a release version of kaufkauflist built with the PocketBase schema.

Then you point a web server's root to /share/kaufkauflist of the kaufkauflist package's derivation (e.g. /nix/store/apcl8vnmal3kph75miff85d840fxxw4n-kaufkauflist-1.0.0/share/kaufkauflist) (That's where all the HTML files, etc. are.) and proxy the /api of pocketbase to the /api of the web server's root.

Take the Caddyfile as a guide on what is required from your web server to make this app run. Just choosing Caddy, of course, makes this easier since you can just flesh out the provided Caddyfile.

For the database, follow the same steps as in Database. Make sure to import the pb_schema.json from /share/pocketbase/pb_schema.json of the kaufkauflist package's derivation (e.g. /nix/store/apcl8vnmal3kph75miff85d840fxxw4n-kaufkauflist-1.0.0/share/pocketbase/pb_schema.json).

License

This project is licensed under the MIT license. You can find a copy of it with the copyright holders in the LICENSE file.