Projects/worblehat
Projects/worblehat
3
1
Fork 0
Code Issues 14 Pull Requests Activity
👉👁️👄👁️👈 - library (as in real books) management system for PVV
24 Commits 2 Branches 0 Tags 919 KiB
Python 91%
HTML 4.9%
TypeScript 2.3%
Nix 1.1%
Mako 0.4%
Other 0.3%
98eed07417
Go to file
h7x4 98eed07417
👉👁️👄👁️👈
2023-05-04 17:24:17 +02:00
data Misc changes: 2023-05-01 01:37:52 +02:00
frontend Setup frontend frame 2022-10-15 19:49:37 +02:00
worblehat Add flake.nix to project 2023-05-04 17:24:17 +02:00
.gitignore Add flake.nix to project 2023-05-04 17:24:17 +02:00
flake.lock Add flake.nix to project 2023-05-04 17:24:17 +02:00
flake.nix Add flake.nix to project 2023-05-04 17:24:17 +02:00
LICENSE Initial commit 2023-04-02 00:59:07 +02:00
poetry.lock Misc changes: 2023-05-04 16:17:35 +02:00
pyproject.toml Add flake.nix to project 2023-05-04 17:24:17 +02:00
README.md 👉👁️👄👁️👈 2023-05-04 17:24:17 +02:00
worblehat.png 👉👁️👄👁️👈 2023-05-04 17:24:17 +02:00

README.md

worblehat

👉👁️👄👁️👈

Worblehat

More information on https://www.pvv.ntnu.no/pvv/Bokhyllen/Worblehat/

What?

Worblehat is a simple library management system written specifically for Programvareverkstedet.

Why?

Programvareverkstedet is a small community with many books and games. A simple web platform is needed to manage the library. We need to know who owns each item, if we can loan it out and where it is.

Programvareverkstedet har en rekke bøker, og en konstant tilstrøm av nye. Teoretisk sett skal disse ryddes og kategoriseres jevntlig, men da dette ikke gjøres ofte nok kan det være et varig strev å finne ut hvor bøker står til enhver tid. Styret har derfor tatt initiativ til å opprette et biblioteksystem for å systematisere bøkene. Prosjektet har fått navn Worblehat etter en bibliotekar i Terry Pratchetts discworld serie. Worblehatt har vært påbegynnt flere ganger opp gjennom historien uten å komme i noen form for funksjonell tilstand enda.

How?

The application is split into frontend and backend. The frontend is written with react-scripts, and communicates with the backed through a REST api.

The backend is written in Flask, and uses an ORM(SQLAlchemy) to store the data in any kind of SQL database.

Technical details

Setup

This project uses [poetry][poetry] as its buildtool as of May 2023.

$ poetry install
$ poetry run alembic migrate
$ poetry run scanner
$ poetry run dev

How to configure

See worblehat/config.py for configurable settings.

TODO List

  • High priority:
    • Book ingestion tool in order to create the database in a quick manner. It should pull data from online ISBN databases (this is almost done)
    • A database with all of PVVs books should be created
    • Ability to request book loans for PVV members, e.g. through Dibblers interface.
  • Low priority:
    • Ability for PVV members to request book loans through the PVV website
    • Ability for PVV members to search for books through the PVV website
  • Discussion
    • Should this project run in a separate tty-instance on Dibblers interface, or should they share the tty with some kind of switching ability?