Skip to content

gafderks/dbase

Repository files navigation

drawing

DBASE

Build Status Codacy branch grade Code Climate maintainability Test Coverage Updates Snyk Vulnerabilities for GitHub Repo time tracker Code style: black GitHub License

Manager for material booking.

Docker management

  1. Build the services using docker-compose up --build
  2. After every update run migrations docker-compose run web python manage.py migrate
  3. Add a super user using docker-compose run web python manage.py createsuperuser

Installation

  1. Install required packages:
    $ sudo apt-get update
    $ sudo apt-get install software-properties-common python3.6 python3.6-venv python3.6-dev python3-pip apache2 libapache2-mod-wsgi-py3 libmysqlclient-dev
    $ sudo apt-get install libjpeg62 libjpeg62-dev zlib1g-dev memcached
  2. Copy the source code to the deployment server. Or clone with git clone https://github.com/gafderks/dbase.git
  3. From within the project directory create a virtual environment and install the project dependencies:
    $ pip install pipenv
    $ pipenv install
  4. Copy the file .env.example to .env and fill in the settings.
  5. Activate the virtual environment with pipenv shell.
  6. Collect static files using (dbase) $ python manage.py collectstatic
  7. Compile the translation files using (dbase) $ python manage.py compilemessages
  8. Load the database configuration with (dbase) $ python manage.py migrate
  9. Create a superuser account using (dbase) $ python manage.py createsuperuser
  10. Import materials, categories, filters, roles and groups using (dbase) $ python manage.py creategroups && python manage.py importfilters && python manage.py importmaterial
  11. Set up the apache web server by copying the file deploy/apache.conf to /etc/apache2/sites-available/example.com.conf and completing the variables at the top. Preferably setup SSL with e.g. LetsEncrypt.

Roadmap

Must have
  • Make games orderable
  • Export to Excel
  • Button material is not listed, put in comments. Material field nullable.
    • MB can convert unlisted material into material
Should have
Could have
  • Suggested material bookings. If you book 'Rambler' it suggests electricity cords.
  • Enable simultaneous editing of bookings and games
  • Info button next to bookings for opening material info modal.
    • For MB: include shortcut for altering material (e.g. category, GM)
  • Contributors file
  • Camera app for quickly adding photos of materials
  • Import games from other events
  • Admin functionality for converting a Material into a MaterialAlias
Won't have