fck-old / bat

BAT Annotation Tool

README

Table of Contents

• [About the Project]
• [Installation]
• [Usage]
• [Contributing]
• [Credits]
• [License]

About The Project

BAT is a tool used to annotate pictures and to get your pictures annotated. Since our project is in the early stages, expect to see a lot of changes in the next few weeks. Created for the module "Scalable Systems" at TU Berlin.

Built With

• Python
• Bootstrap
• Django
• Docker

Installation

To get a local copy up and running follow these simple steps.

• Python Download lastest version at https://www.python.org/downloads/ and follow the installation instructions (It is recommended to use a virtual environment with python, but is not mandatory)

• npm

npm install npm@latest -g

• Django

pip install django

• Bootstrap

npm install bootstrap

• Pillow

pip install pillow

1. Clone the repo

git clone https://frankkohlhepp/BAT.git

2. Start the server

YourPathToTheProject\BAT\batproject python manage.py runserver

Installing with Docker

1. Install docker here and make sure it's running on your system.

2. Install docker-compose

You can also use pip

pip install docker-compose

OR without using a virtualenv:

sudo pip install docker-compose

3. Clone the repo

git clone https://frankkohlhepp/BAT.git

4. (Linux) Make deploy.sh exacutable:

chmod +x deploy.sh

5. (Linux) Run deploy.sh with:

./deploy.sh

6. (Optional) In deploy.sh comment out line 8 (with #) cp docker/settings.py batproject/batproject/settings.py to use non deployment settings (eg.: DEBUG = True)

Usage

Open http://localhost:8000/batproject in any browser and you will see a local version of BAT. In the next weeks, we are adding the possibility to host the server on docker and other platforms.

Contributing

Since open source project are about contributing to projects, feel free to fork our repository.

If you want to develop any new features, make sure to open a new branch and to always keep your repository up to date.

After you have changed something or finished your new feature, make sure to commit your changed and make a pull request.

Any member of our development team is allowed to merge pull requests.

Credits

Product Owner: Markus Städler

Scrum-Master: Louis Loechel

QA: Felix Dannenberg

Frontend: Gergana Vladimirova, Frank Kohlhepp

Backend: Henning Schaaf, Vincent Spell

DevOps: James Laycock

License

Distributed under the MIT License. See LICENSE for more information.

bat's Issues

Account Bearbeiten

Research Google Cloud/Kubernetes

Docker kennen lernen [2h]

Deployment automatisieren

• environment variblen 1h

• google secrets / env variblen speichern 0.5h

• 2. settings.py 0.5h

• testen 0.5h

• (Github Actions 2.5h)

• Script schreiben 1h

5h

Readme & Wiki [3h]

Stresstests für das Up and Downloaden von Bildern

Entwicklungszeit: 2,5 Stunden

Accountmanagement Page

Time: 4h

Admin Funktionalitäten für Benutzeraccount bearbeiten

Entwicklungszeit: 2 Stunden

Connect Github Actions to Google Cloud

2h

Implementierung Annotation

Stresstests für das Taggen von Bildern

Entwicklungszeit: 3 Stunden

Skipen von ungetagten Bildern durch Nutzer

implement deployment design [5h]

Kubernetes Deployment

Sprint 1 Code aufräumen

Allgemein

• Schattenrahmen vereinheitlichen
• Username/PW Rahmen-Hack sauber implementieren
• BAT Schriftart überall vorhanden? bzw. stattdessen als .png?
• Bilder maximal hochskalierten
• ausgewähltes Menüelement farbl. hinterlegen (Low priority)
• Navbar neue Farbe (Low priority)

Mobile

• Login Button verrutscht
• Hintergrund verrutscht
• Dashboard resposnive

fix static content

• type MIME to text/css

• static content paths

• static content collection

Time (Frontend + DevOps) : 2h

User Media on depolyment

• set up bucket

• connect bucket

• test/debug requesting/posting media

• (permissions?)
  2h

Account Funktionalität [19h]

Verknüfung der Ansicht für den Nutzer und der Datenbank (beim Hochladen von Fotos, beim Anlegen eines neuen Accounts und beim Einloggen)

Konzept Projektstruktur/Ordnerstruktur [3h]

Stresstests für login/logout

Entwicklungszeit: 3 Stunden

Landing Page Animation

(low priority)

Time: 7h

Create Github Actions

Update README

Verbindung Login/Register

Account Löschen

Deployment Concept

Designkonzept [24h]

Upload von Bildern [11h]

Ein ungetagtes Bild an den User zurückgeben

speichern der getaggten Bildkoordinaten

Entwicklungszeit: 3 Stunden

Skalierbarkeit testen

• Tools erkunden

• Tests schreiben

• Tests ausfuehren

• Daten auswerten

(DevOps: 2h)
(Backend: 2h)

Verbindung Tag-Funktion

Time: 3h

Technologie für Annotation bestimmen (Recherche)

Verbindung Account löschen/bearbeiten

Schnittstellen Backend und Deployment (Speichern/Abruf von Bilddateien)

Entwicklungszeit: 4 Stunden

Einarbeitung in Stresstests

Entwicklungszeit: 3 Stunden

Konzept für Deployment [1h]

Test [2h]

deploy to raspberry pi

Einarbeiten in postgreSQL

CI/CD Concept

Testing/Debugging

getaggte Bilder mit Bildkoordinaten an den User zurückgeben

Entwicklungszeit: 2 Stunden

Account Interface [8h]

Aufbereitung & Darstellung der Messergebnisse (Stresstest)

Time: 6h

Translate Backlog

Ubuntu VM Deployment (Learning)

regestration email

confirm email address for more features

Deployment mit Kubernetes

• research/concept 4h

• setup 4h

• Deployment 3h

• Testing 1h

12h

Nutzer kann Label festlegen