annaaurora
/
kaufkauflist
1
2
Fork 1
Code Issues 7 Pull Requests Packages Projects Releases Wiki Activity
A to-do list web app for shopping or other use cases https://kaufkauflist.annaaurora.eu
63 Commits
1 Branch
7 Tags
646 KiB
JavaScript 59%
Svelte 32.3%
HTML 8.1%
Nix 0.6%
 
 
 
 
Go to file
Anna Aurora cf54855c68
Removed useless buttons. 
You can just scroll to the top or bottom and delete the first or last item instead.
 		2023-12-09 23:09:03 +01:00
src Removed useless buttons. 2023-12-09 23:09:03 +01:00
.eslintignore Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
.eslintrc.cjs Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
.gitignore Added database folder not made to be commited to gitingnore. 2022-12-26 17:43:04 +01:00
.npmignore Made npm ignore some files for install. 2023-05-14 21:29:42 +02:00
.npmrc Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
.prettierignore Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
.prettierrc Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
Caddyfile Made Svelte be responsible for the CSP, not the web server. 2023-05-14 15:49:56 +02:00
LICENSE Remove deprecated stuff from Caddyfile, add comments and improve caching. 2023-01-07 23:21:34 +01:00
README.md Ran `npm run format`. 2023-01-08 12:38:22 +01:00
cleanup.js Moved commandline arguments of the cleanup script into environment variables. 2023-10-01 15:27:29 +02:00
jsconfig.json Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00
package-lock.json Updated dependencies and modified code to work with them. 2023-10-01 16:35:22 +02:00
package.json Updated dependencies and modified code to work with them. 2023-10-01 16:35:22 +02:00
pb_schema.json Merged collections users and lists. 2023-02-03 16:16:21 +01:00
shell.nix Added documentation to readme. 2023-01-08 12:38:15 +01:00
svelte.config.js Removed `script-src-attr 'none'` from CSP because there's no `'nsafe-inline'` in `script-src` anyway. 2023-12-04 09:41:12 +01:00
vite.config.js Init project with config files and basic functionality of the app. 2022-11-23 16:19:17 +01:00

README.md

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.