~timharek/hima

Home Inventory Management Application made with Deno and Pocketbase
docs: Add more instructions
1d368c3f — builds.sr.ht 2 months ago
chore(release): Update CHANGELOG

clone

read-only
https://git.sr.ht/~timharek/hima
read/write
git@git.sr.ht:~timharek/hima

You can also use your local clone with git send-email.

#Hima

builds.sr.ht status

Hima - Home Inventory Management Application. Hima also means "home" in a Norwegian dialect.

Hima is a home inventory system that helps you keep track of your belongings. You can create a list of your items, including details like photos, purchase dates, and values. With Hima, you can easily organize and manage your belongings, and have a comprehensive record of your possessions in case of loss, damage, or theft.

It's built using Deno, Fresh and PocketBase. It's made to be lightweight and fast. It's a work in progress atm.

#Development

#Prerequisites

  1. Deno installed, a version supporting at least Fresh v1.6.8.
  2. PocketBase (PB) installed, at least v0.21.1.

#Usage

  1. Copy the .env.defaults, cp .env.defaults .env and update the variables accordingly.
  2. Start the backend: deno task pb.
  3. Create an admin-user in PocketBase-interface.
  4. Create a new user in the users-collection.
  5. Start the frontend in dev-mode: deno task dev.
  6. Log in using the newly created user.

Now you have both the frontend and backend running and you're ready to write some code. For more Deno scripts to run, please checkout deno.json for more details.

#Troubleshooting

If you are redirected to /no-backend, please check out the logs from Deno.

#Deploying to production

See seperate production docs for more details.

#How I run the project

As of 2023-04-06 I'm running this project on a Linux server with both hima and PB running as systemd-services. I'm using reverse proxies with Caddy to have both run on the same server.

#Contributing

Anyone can contribute to Hima. Please refer to the contribution guidelines

Send patches to the mailing list, report bugs on the issue tracker.

Made with Fresh