matthew/BrickTracker
1
0
Fork 0
forked from FrederikBaerentsen/BrickTracker
Code Pull Requests Activity

Complete the list of libs used as well as credit for the logo designer

Browse Source
This commit is contained in:
Gregoo 2025-01-24 11:06:26 +01:00
parent d919f7b972
commit 89fe0646a0
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/development.md
View File

@ -4,14 +4,26 @@
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
The application is written in Python version 3. The application is written in Python version 3.
It uses: It uses the following Python/pip packages:
- `flask` (Web framework) - `flask` (Web framework)
- `flask_socketio` (Socket.IO: Websocket library for real-time client-server communication) - `flask_socketio` (Socket.IO: Websocket library for real-time client-server communication)
- `flask-login` (Lightweight Flask authentication library) - `flask-login` (Lightweight Flask authentication library)
- `humanize` (Unit and datetime conversion)
- `sqlite3` (Light database management system) - `sqlite3` (Light database management system)
- `rebrick` API (Library to interact with the Rebrickable.com API) - `rebrick` API (Library to interact with the Rebrickable.com API)
It also uses the following libraries and frameworks:
- Boostrap (https://getbootstrap.com/)
- `baguettebox` (https://github.com/feimosi/baguetteBox.js)
- `tinysort` (https://github.com/Sjeiti/TinySort)
- `sortable` (https://github.com/tofsjonas/sortable)
- `simple-datatables` (https://github.com/fiduswriter/simple-datatables)
The BrickTracker brick logo is part of the Small n' Flat Icons set designed by [Arnaud Chesne](https://iconduck.com/designers/arnaud-chesne).
## Running a local debug instance ## Running a local debug instance
You can use the [compose.local.yaml](../compose.local.yaml) file to build and run an instance with debug enabled and on a different port (`3334`). You can use the [compose.local.yaml](../compose.local.yaml) file to build and run an instance with debug enabled and on a different port (`3334`).