worblehat/README.md

# 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.

```console
$ 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?
Add readme and requirements 2022-08-16 22:13:48 +02:00			`# Worblehat`
Initial commit 2023-04-01 20:40:41 +02:00
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00			`More information on <https://www.pvv.ntnu.no/pvv/Bokhyllen/Worblehat/>`

Add readme and requirements 2022-08-16 22:13:48 +02:00			`## What?`
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00
Add readme and requirements 2022-08-16 22:13:48 +02:00			`Worblehat is a simple library management system written specifically for Programvareverkstedet.`

			`## Why?`
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00
Add readme and requirements 2022-08-16 22:13:48 +02:00			`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.`

Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`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.`
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00			`Worblehatt har vært påbegynnt flere ganger opp gjennom historien uten å komme i noen form for funksjonell tilstand enda.`

Add readme and requirements 2022-08-16 22:13:48 +02:00			`## How?`

Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`The application is split into frontend and backend. The frontend is written with react-scripts, and communicates with the backed through a REST api.`
Add readme and requirements 2022-08-16 22:13:48 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`The backend is written in Flask, and uses an ORM(SQLAlchemy) to store the data in any kind of SQL database.`
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`# Technical details`
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`## Setup`
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`This project uses [poetry][poetry] as its buildtool as of May 2023.`
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			```console
			`$ poetry install`
			`$ poetry run alembic migrate`
			`$ poetry run scanner`
			`$ poetry run dev`
			```
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme 2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`## How to configure`
Foreslo en alternativ prosedyre til bygging av databasen 2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			See `worblehat/config.py` for configurable settings.
Foreslo en alternativ prosedyre til bygging av databasen 2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`## TODO List`
Foreslo en alternativ prosedyre til bygging av databasen 2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes 2023-05-04 16:17:35 +02:00			`- [ ] 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?`