BennerLukas/Biblio

private library tool for books and magazines.

Biblio

Documentation

Biblio is a tool for your private library. It manages your books and magazines.

Composed Docker Containers

Otherwise, you can use the docker-image provided in the repository.

The first time you use this docker-compose you must initialise the containers with:

cd biblio
docker compose up

The Frontend is now visible under localhost:5000

Afterwards, the container may be started with

docker compose start

To shut down the container you can either use a different terminal and use

docker compose stop

or by pressing Ctrl + C in the terminal used to initialise the container.

[DEPRECATED] Using by hand

current version does not support old connection type. Please use docker.

There are two main ways to start using biblio in a development environment. The first is to use your location python intallation. The second is to use a docker-compose which is described under the next paragraph.

To use your local python installation you need to firstly install the given packages:

pip install -r requirements.txt

Secondly, create the database container:

docker container run -p 5433:5432 --name biblio -e POSTGRES_PASSWORD=1234 postgres:12.2 

Then initialise the biblio database by running :

cd src/code
python init.py

After that start the flask server by:

cd src/code
python run.py

For executing PostgreSQL inside the docker container

docker exec -it biblio bash 
psql --dbname=postgres --username=postgres

More Information

For more information see here: https://github.com/BennerLukas/biblio/blob/main/doc/DB/biblio.md