mac641 / audio-converter

audio-converter allows you to convert audio files from within your web browser.

Hi there 👋

I'm Marcel. Welcome to my GitHub profile!

👷 Check out what I'm currently working on

🌱 My latest projects

• mac641/gotep - gotep is a terminal-based REST client designed to execute HTTP tests based on the Jetbrains HTTP-Client.
• mac641/audio-converter - audio-converter allows you to convert audio files from within your web browser.
• mac641/tab-split-merger - Tab Split Merger for Firefox splits tabs into multiple windows and merges them back together into one.

📓 Gists I wrote

• Install Alpine Linux on WSL and connect it to Docker Desktop
• Installing Fedora CoreOS on VirtualBox on Windows 10

📫 How to reach me

Feel free to shoot me a message anytime! :)

• LinkedIn: https://www.linkedin.com/in/mac641/
• Mastodon: https://mastodon.art/@mac641

audio-converter's Issues

As audio-converter user I want to be presented with a home screen when initially visiting the website.

Acceptance criteria

• The home screen provides general information about the app including
  • headline
  • short introduction
  • "Get started"-button which redirects to the drag&drop screen
  • "Login"-button

As audio-converter user I want to be able to translate error messages as I am able to do on every other page.

Acceptance criteria

• Every error page template uses the babelex translation
• Every error page template contains the translation flag and can be translated by the user by clicking on it

Fix wrong timezone in log file

Issue

audio-converter.log currently doesn't CET, even though the actual has been mounted into the docker container.

Acceptance criteria

• Make python logging use docker's local timezone

As audio-converter user I want to have insights into imprint and privacy notices.

Acceptance criteria

• Imprint has been generated and inserted into imprint.html
• Privacy Notice has been generated and inserted into privacy.html

As audio-converter developer I want to utilize a clean documentation.

Acceptance criteria

• The documentation is intuitively structured.
• The documentation is easily understandable.
• The documentation contains
  • a roadmap including implemented features.
  • possible features for future continuation of the project.
    • e.g. dark / light theme
    • e.g. wider conversion format support
    • e.g. edit audio file meta data
    • e.g. access previously converted audio files via user account settings
• The documentation will be in English.

As audio-converter user I want to be presented with a unified color schema.

Acceptance criteria

• All templates use one signal color.
• Basic design is implemented using greyscale colors.
• All templates use a modern, readable font.
• Buttons and pictograms are arranged intuitively.

As audio-converter user I want to be presented with a header and footer on every screen.

Acceptance criteria

• Header and footer are visible on every screen.
  • Optional: Perhaps footer is hidden on home screen.
• Header and footer are adjusted depending on every screen
  • For example, user information logo, etc.
• The header logo redirects to the home screen.
• The footer includes copyright mentions, privacy information and an imprint.

As audio-converter user I want to be presented with a loading page while my audio files are being converted.

needs #5

Acceptance criteria

• A separate html file exists for displaying loading info
• Converting tasks invoked from convert.html are triggered by using js rather than python (avoidance of longer load times while nothing is being presented to the user)
• If no files have been selected for uploading and the user clicks on the upload button anyways, display an error message which encourages the user to upload at least one file.

As audio-converter user I want to be able to sort the history after columns.

Acceptance criteria

• Table can be sorted by
  • name
  • format
  • date

Add cleanup feature

Acceptance criteria

• The converted folder can be cleaned up via a button within the settings
• History and related conversion count in DB will be reset
• Reset conversion count

As audio-converter user I want to be presented with a "Conversion" screen which allows to upload audio files for conversion.

Acceptance criteria

• User is presented with drag&drop screen to upload audio files for conversion
• User is presented with file browser to upload audio files for conversion
• User is presented with drop down menus where it can further specify its destination file format.
• Uploads shall be deleted after every successful conversion AND before uploading new files.

As audio-converter user I want to be able to monitor insights about previous conversion tasks.

Acceptance criteria

• User can switch to a logging view where previous conversion tasks are displayed
  • Optional: User is able to download previously converted audio files

Resolve TODOs / FIXMEs

Acceptance criteria

• All TODOs have been resolved
• All FIXMEs have been resolved
• TODOs, not mandatory for AWmP, are allowed to remain

Additionally

• Format all files
• Optimize all imports
• Delete .designs folder

As audio-converter user I want to use a feature-rich settings page.

Acceptance criteria

• Every TODO regarding this topic has been resolved and removed
• Settings includes features to
  • decide which archive compression algorithm shall be used
  • reset a users email
  • enter user name
  • select audio type bitrate

As audio-converter user/developer I want to be presented with comprehensive error pages.

Acceptance criteria

• An error page template has been created and accepts two variables
  1. error_message: includes a description about the error
  2. error_code: includes the http error code

As audio-converter developer I want to set specific tokens to authenticate specific users.

Acceptance criteria

• All comments tagged with FIXME have been resolved

Redesign configs

Acceptance criteria

• local_config.py has been renamed to user_config.py
• config.py is read-only for every user

Suggestion

• Adjust file permissions in .docker/dev.Dockerfile, .docker/prod.Dockerfile

Bugfixes for #34

Acceptance criteria

• Files won't be stored in anonymous folder when not logged in -> In order to work properly, they have to be stored inside anonymous
• Converting files removes some letters before and after the file -> In order to work properly, fix cutting pre- / postfixes randomly
  • Especially noticeable, when uploading multiple files with numbers in their file names
  • e.g.: Piano2.mp3 -> iano2.m
• Fix huge 'Convert again' button on download page
• Move files into user specific directory
• Add css variable with color for css borders of conversation boxes (light blue -> dark blue)

As audio-converter user I want my audio files to be compared using MIME types.

Acceptance criteria

• Every compare operation involving audio files uses MIME types
• Every TODO regarding this topic has been resolved and removed

As audio-converter user I want to edit my user information.

Acceptance criteria

• User is provided with information screen about its stored data and has option to edit them.

Redesign backend endpoints

Currently backend endpoints provide rather random urls to access them.
It would be easier to use, if:

• every endpoint which does not provide a html page is prefixed with /api/
• all underscores in api urls have been replaced by /

As audio-converter developer I want to be able to utilize docker as develop environment to be independent of host OS'.

Acceptance criteria

• The docker container includes all relevant files for development.
• The docker container can be started using compose.
• The docker container serves the app.

As audio-converter developer I want to be able to administer users, settings, etc. from a browser interface.

Notes

• Use Flask-Security-Too

As audio-converter user I want my converted audio files to be stored in a specific folder.

needs #5

Acceptance criteria

• Converted audio files are stored in a specific folder (with subfolders named with user-id for every logged-in user)
• Hashes to these files are stored in the database and are associated with the proper user.
• Converted files from unknown users will be deleted immediately after browsing to a new page or disconnecting.

As audio-converter user I want to switch between German and English.

Acceptance criteria

• The website header includes button to switch between previously mentioned languages.
• All html files are available in German and English.

Add loading screen for download page

Acceptance criteria

• Loading circle similar to convert site is triggered when clicking the download button
• Register even to let client know when a download popup was triggered and hide loading circle due to that

As audio-converter developer I want to make the project run.

Make download.py accept list of paths

Acceptance criteria

• download.py zip function accepts list of paths as arguments and uses them to generate a downloadable zip file

Create pipeline for automatic deploy of prod image to docker hub

Acceptance criteria

• Docker image is being built automatically
• Docker image is being committed and deployed automatically

Enhance button info on hover

Acceptance criteria

• Every menu button contains a description which will be displayed on hovering (title-tag in HTML)

As audio-converter developer I want to use reliable logging messages.

Acceptance criteria

• All critical tasks are logged on the server-side
• All critical tasks are logged on the client-side

Bugfixes

Acceptance criteria

• Converting files removes some letters before and after the file
  • Especially noticeable, when uploading multiple files with numbers in their file names
  • e.g.: Piano2.mp3 -> iano2.m
• If you selected the same file type as the files you have uploaded are already converted into, the resulting zip file is empty
• utils.py calls create_path within delete_path -> remove it

Enhance responsive design

Acceptance criteria

• When decreasing browser window height, ensure that contents do not overlap

As audio-converter user I want to reset my password from the user-information screen.

Acceptance criteria

• User is able to reset its password from the user-information screen.
• While resetting the password, data integrity within the database has to be guaranteed.

As audio-converter user I want to register and sign in to the system.

Acceptance criteria

• On the "home" screen the user will be displayed with a login button which redirects to the login screen.
• A login screen is implemented.
• User is able to register and its information is persisted in the database
• User is able to log in by providing its username and password

Notes

• Use Flask-Login

As audio-converter admin I want to have a protected admin page

As audio-converter user I want to sing out.

Acceptance criteria

• User is able to sing out on the side header.

Add mobile support

Acceptance criteria

• All html pages are visible on mobile phones and are displayed properly visible
• All html pages are optimized for touch / gesture controlled devices
• Mobile users are able to upload audio files
• Mobile users are able to download a resulting zip archive

Tips for approaching

• Use css @media queries to detect different display ratios / sizes in pixels

As audio-converter user I want to reset my password from the login screen.

Acceptance criteria

• User is able to reset its password from the login screen.
• While resetting the password, data integrity within the database has to be guaranteed.