43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
# LibrarySystem
|
|
|
|
universal library system for facilities in the university. Currently hard-coded for the Library of the University of Education in Freiburg, Germany, but can be adapted to fit other libraries as long as the catalogue has a suitable format, or an open API
|
|
|
|
Other Libraries can be supported by rewriting the catalog and it's corresponding functions.
|
|
|
|
## What is this?
|
|
|
|
This is a library system for the different facilities in our university. Because some facilities lend their media, some wanted a software that allows them to keep track of who had what when.
|
|
|
|
### Installation
|
|
#### Windows
|
|
For windows, there are two ways to install the software:
|
|
|
|
1. using the latest git commit version:
|
|
|
|
Prerequisites:
|
|
- [uv](https://docs.astral.sh/uv/getting-started/installation/) and [Git](https://git-scm.com/downloads/win) are installed
|
|
|
|
```bash
|
|
git clone https://git.theprivateserver.de/WorldTeacher/LibrarySystem.git
|
|
cd LibrarySystem
|
|
uv sync # This will install all dependencies, including dev dependencies
|
|
source venv/Scrpits/activate(.bat|ps1) # This will activate the virtual environment
|
|
uv run python main.py
|
|
```
|
|
|
|
building the software:
|
|
```bash
|
|
uv run python build.py
|
|
```
|
|
This will create a build folder with the application in it. You can move the folder of the application anywhere you want
|
|
|
|
2. using the release:
|
|
|
|
~~see: [releases](https://git.theprivateserver.de/WorldTeacher/LibrarySystem/releases)
|
|
and download the latest version~~ (not yet supported)
|
|
|
|
|
|
### Configuration
|
|
|
|
the software contains a config file in configs, as well as a config for icons, located in icons.
|
|
By default, the software will use the installation directory for all files, but you can change that in the config file, or using the settings window in the software. |