cmu-313 / teedy

Teedy is an open source, lightweight document management system for individuals and businesses.

Features

• Responsive user interface
• Optical character recognition
• LDAP authentication
• Support image, PDF, ODT, DOCX, PPTX files
• Video file support
• Flexible search engine with suggestions and highlighting
• Full text search in all supported files
• All Dublin Core metadata
• Custom user-defined metadata
• Workflow system
• 256-bit AES encryption of stored files
• File versioning
• Tag system with nesting
• Import document from email (EML format)
• Automatic inbox scanning and importing
• User/group permission system
• 2-factor authentication
• Hierarchical groups
• Audit log
• Comments
• Storage quota per user
• Document sharing by URL
• RESTful Web API
• Webhooks to trigger external service
• Bulk files importer (single or scan mode)
• Tested to one million documents

Native Installation

Requirements

Before building Teedy from source, you will need to install several prerequisites, including Java 11+, Maven 3+, NPM, Grunt, Tesseract 4, ffmpeg, and mediainfo. We give instructions for installing these prerequisites on several platforms below.

Linux (Ubuntu 22.04)

sudo apt install \
  default-jdk \
  ffmpeg \
  grunt \
  maven \
  npm \
  tesseract-ocr \
  tesseract-ocr-ara \
  tesseract-ocr-ces \
  tesseract-ocr-chi-sim \
  tesseract-ocr-chi-tra \
  tesseract-ocr-dan \
  tesseract-ocr-deu \
  tesseract-ocr-fin \
  tesseract-ocr-fra \
  tesseract-ocr-heb \
  tesseract-ocr-hin \
  tesseract-ocr-hun \
  tesseract-ocr-ita \
  tesseract-ocr-jpn \
  tesseract-ocr-kor \
  tesseract-ocr-lav \
  tesseract-ocr-nld \
  tesseract-ocr-nor \
  tesseract-ocr-pol \
  tesseract-ocr-por \
  tesseract-ocr-rus \
  tesseract-ocr-spa \
  tesseract-ocr-swe \
  tesseract-ocr-tha \
  tesseract-ocr-tur \
  tesseract-ocr-ukr \
  tesseract-ocr-vie

Mac

brew install \
  ffmpeg \
  grunt-cli \
  maven \
  mediainfo \
  npm \
  openjdk \
  tesseract \
  tesseract-lang

Windows

It is highly recommended that you proceed to install Windows Subsystem Linux (WSL), following the link: Install Linux on Windows with WSL . This will allow you to run a Linux distro (Ubuntu's the default) within the Windows environment, and you can then proceed to follow the Linux (Ubuntu 22.04) instructions to install the dependencies.

Note: This would mean that you should proceed to execute the following instructions within the Linux environment as well.

Installation Steps

Clone the repository to your local machine (git clone https://github.com/CMU-313/Teedy) and then use Maven to build Teedy from source by running the following command from the root directory:

mvn clean -DskipTests install

After successfully building Teedy from source, you can launch a Teedy instance by running the following commands from the root directory:

cd docs-web
mvn jetty:run

The default admin password is "admin". Don't forget to change it before going to production.

License

Teedy is released under the terms of the GPL license. See COPYING for more information or see http://opensource.org/licenses/GPL-2.0.

teedy's Issues

Improve Accessibility by ensuring lists only contain <li> elements and supporting elements

Currently on the user settings page, the list structure on the page can be improved by addressing the following issue:

Accessibility score can be improved by removing any elements that are not <li>, <script>, or <template> elements.

Improve accessibility score by improving contrast ratio

The current accessibility score is 80. I would like to target the warning that states that the contrast ratio of background/foreground colors is insufficient, making it difficult for users to read

Improve accessibility by increasing contrast of text and button elements on login page

The current accessibility score on the login page is 86. Specific elements that Lighthouse highlighted were the forgot password popup and different buttons and plaintext boxes.

It appears that students have chosen to improve the contrast on other pages, but no one has tackled the login page with accessibility 86 yet.

Improve accessibility by adding [lang] attribute to html element

The google lighthouse showed the current accessibility score is 86 with a warning " element does not have a [lang] attribute" for INTERNATIONALIZATION AND LOCALIZATION section. By specifying the language, the webpage can better locate the target audience.

Improve accessibility score by giving buttons accessible names on "Documents" page

The "Documents" page has a accessibility score of 80%, and the following issue should be addressed:
Buttons do not have an accessible name. When a button doesn't have an accessible name, screen readers announce it as "button", making it unusable for users who rely on screen readers.

Improve accessibility score by increasing contrast between background and foreground colors on Tags page

The current accessibility score is 84 for this page. The warning I am targeting is that the background and foreground colors do not have a sufficient contrast ratio.

Improving accessibility score by adding appropriate semantic tags and changing page contrast (tag page)

The current accessibility score is 84, and in order to improve this score, the warning that I am paying heed to is to enhance the legibility of the content, and improve the usage of ARIA in my application.

I will do this by working with the aria attributes and changing contrasts of the site to make it more accessible and legible.

Improve SEO by making tap targets larger for the mobile login page

In the current mobile version, only 80% of the tap targets are appropriately sized. This doesn't meet the recommended 48px by 48px tap box. The current SEO score is 64.

Improve SEO Score by adding meta description on the documents page

Before adding the meta description of the documents page, the SEO score for the documents page is 78. One of the warnings for the score was: "Document does not have a meta description
Meta descriptions may be included in search results to concisely summarize page content. Learn more."

Testing new Github Actions

Improve Accessibility score by adding [lang] attribute to <html> element for Settings -> Two-factor authentication page

Currently the accessibility score for this page is 89, and one of the issues is that the element does not have a specified [lang] attribute, which could cause the screen reader to not announce the text correctly if the text is not written in the default language.

The goal is to specify the language to ensure this doesn't occur.

Improve Accessibility score by adding [lang] attribute to <html> element for the TAGS PAGE

Currently, the Accessibility score for the Tags page is 86. One of the issues that contributes to this low score is that the page doesn't specify a lang attribute. To increase the Accessibility score, I added the lang attribute to the Tags page. This sets the language of the document to English for the screen reader to know.

Improve branch coverage in TestVocabularyResource by testing unauthenticated users and null update parameters

The current branch coverage for this file is 54%.

The current branches which are not covered by tests are:

1. Branches that check whether or not a user is authenticated
2. Branches that check whether or not a resource exists before updating or deleting
3. Branches that check whether or not update parameters are null

Improving SEO score in the Users / Groups tab by adding meta descriptions

In the user / groups tab where there is an index of users and I can further read into Admin and Guest, the SEO score is 78. I want to improve this by adding meta descriptions to the index page and the details pages.

Improve Accessibility score by adding [lang] attribute to <html> element for Users & Group page

This page (http://localhost:8080/src/#/user) currently has an accessibility score of 95. It has the issue that the element does not have a [lang] attribute, which makes the screen reader assume this page is in the default language. But the screen reader will not pronounce the webpage correctly if the page is not in the default language.

Improve SEO score by making links crawlable

The current SEO score is 70. This is the warning I am targeting: Search engines may use href attributes on links to crawl websites. Ensure that the href attribute of anchor elements links to an appropriate destination, so more pages of the site can be discovered. [Learn More]

Improving accessibility score by giving buttons accessible names

The accessibility score I observe on the tags page is 86. Having more accessible/insightful button names can help those who use assistive technologies (like screen readers).

Improve Accessibility score on Login page by adding alt text to images

The current metric score for Accessibility is 86 on the login page. One reason for this lower score is because of the missing [alt] attribute from the Teedy logo image tag. Since the logo is an informative element, alt text should be added to describe it.

Improve SEO Score by making font sizes legible

The current SEO Score is 64%. In the section the Mobile Friendly section, it states that the document doesn't use legible font sizes (only 49% of it is legible). I can change all the font sizes to be at least 12px for mobile visitors.

Improve SEO by adding image alt attributes

The current SEO score of the Teedy is 64. Informative elements should have short, descriptive alt text. This is not the case for one element.

Improve Accessibility score when viewing an existing tag by giving buttons accessible names

Current Accessibility score: 79.
Comment reads: "Buttons do not have an accessible name. When a button doesn't have an accessible name, screen readers announce it as "button", making it unusable for users who rely on screen readers." Giving buttons descriptives names this will be of benefit to users using screen readers or other assistive technologies.

Improve accessibility score by giving buttons accessible names on the "Tags" page

The current "Accessibility" score for the tags page is 84. I will improve this by making buttons have accessible names.

Improve accessibility by adding associated labels to form elements in Settings->General Settings->Vocabularies

The current accessibility score is 86. The warning I am targeting is "Form elements do not have associated labels" in the Settings->General Settings->Vocabularies. Labels make sure form controls are announced correctly by assistive technologies, so users who rely on assistive technology can navigate to different pages correctly.

Improve SEO by adding [alt] attributes to image elements

Currently, image elements do not have [alt] attributes
current SEO score: 73
target: 75

Improve accessibility by adding [alt] attributes to image elements

The metric I am targeting is accessibility, which has a current score of 86. I would like to improve it by adding alt text to the image elements, which is helpful as it provides a description of the image.

Fix Github Actions

The github actions currently builds a docker image. Instead, we want it to run the tests, and report the coverage numbers. Also, it should not upload to docker hub.

Improve "Accessibility" score by making button have an accessible name on the "Tags" site

Improve accessibility score by adding discernible link names on Documents page

Current accessibility score of 82 on the Documents page after a document is uploaded. The buttons to navigate home and the link to document button are missing discernible link names

Improving Accessibility score by giving buttons useful names

Currently, the accessibility score is 76. I will target the warning that describes how quite a few of the buttons on the page do not have accessible names, causing screen readers to announce it as a "button" and making it unusable for users who rely on screen readers.
To fix this issue, I will give these buttons more specific names.

Improve Accessibility by ensuring Interactive controls are keyboard focusable

Current Score: 82
Issue Targeting: Interactive controls are keyboard focusable

Elements such as the search button, List v Grid view, and Previous/Next are not keyboard accessible through tabbing.

Improve SEO score by fixing empty hrefs

The current SEO score is 70. One of the warnings suggested that the empty hrefs be addressed by filling in empty links, which can either be done by adding a proper link to each href or by changing the a tags to span tags.

Improve Accessbility score by fixing aria attributes that do not match their roles

The current score I observed is 80, and the waring I received is "[aria-*] attributes do not match their roles".
According to the LightHouse manual, each ARIA role supports a specific subset of aria-* attributes. Applying an attribute to a role that doesn't support it generally won't break the role, but it should still be fixed.

Improve Accessibility score by adding labels to form elements in custom metadata configuration settings

Current Accessibility is 83 and the warning that I am targeting is "Form elements do not have associated labels". This appears after adding after adding a metadata name to the table.

Improve SEO by making the tap targets appropriately sized

Currently only 80% of the targets are appropriately sized. This means the other 20% of the targets are either not large enough or don't have enough space around them to be easy for a user to tap without overlapping onto other elements. This issue will fix this 20%, and improved the SEO which is currently 88.

Improve SEO score by adding [alt] attributes to image elements

The current SEO score is 70. The teedy image, as of now, does not have informative elements. I would like to add informative elements in the form of short, descriptive alternate text. Hopefully this will raise the SEO score by a few points.

Improve "Accessibility" score by making button have an accessible name on the "Tags" page when a user creates a new tag

Currently, the Accessibility score for the Tags page when a user creates a new tag is 77. One of the problems on top of the button not having an accessible name on the Tags page is also the button when a user creates a new tag within the Tags page. That button also does not have an accessible name. This is important because the purpose of the tags page is create tags, if each new tag's setting doesn't have an accessible name but the Tags page does, this page is still not 100% accessible.

Improve Accessibility by increasing background and foreground contrast ratios

Low contrast text may be hard to read
Can be improved by darkening some of the background making it easier to discern important elements

Improving SEO by making links crawlable

The current SEO score of the Teedy is 78. One of the main reasons for this is that many of its links are not crawlable, which can hinder access to some pages.

Improving Accessibility Score by changing the links to have more discernable names (Home Button)

Improve accessibility score by adding label to image

Using Google Lighthouse, the current accessibility score is 86. The warning being targeted is "Image elements do not have [alt] attributes". This change is aimed at improving the experience for users of assistive technology like a screen reader by improving the semantics of the controls in Teedy.

Improve accessibility by giving links useful names

Right now the accessibility score is 82. The warning I am targeting is the links do not have discernable names. This makes it harder for those using screen readers to tell what some links lead to.

Improve Accessibility score by Adding [lang] attribute

Currently, the Accessibility score is 80. I aim to improve this by score by adding the [lang] attribute to the html element an improve the interpretation content by users in different locales.

Improve performance score by minifying large JavaScript files

The current performance score by Lighthouse is 49. I am targeting the warning "Minify JavaScript" which says that the JavaScript files can be minified to reduce payload sizes and script parse times.

This change will minify some of the JavaScript files to improve the performance score.

[Enhancement] Improving SEO score by adding meta description

Current score from lighthouse gives SEO a 78, penalizes it because there is a lack of a meta description in the content.

This change will aim to add a meta description to the document, hence improving the SEO score.

Improve accessibility score by making heading elements in a sequentially-descending order

Improve the SEO score by adding a meta description

The current Lighthouse SEO score is 70% (for the login page on desktop). The following issue needs to be addressed:

Improve Accessibility by fixing focusable elements on "aria-hidden=True"

In the "user" page, the accessibility score is currently 90. I want to improve this score by fixing the "ara-hidden =True" elements to allow interactive elements to be available.

Improve Accessibility Score in settings/vocabularies by providing labels for form control

The current Accessibility score is an 86, and I am targeting the warning concerning "Form elements do not have associated labels" on the settings/vocabularies page which advises that labels should be provided for the form control for those with impaired vision

Improve Best Practices Score by fixing the existing vulnerabilites of the AngularJS and JQuery UI libraries

Currently, the Best Practices score is 92. I intend to improve this score by trying to use different versions of the 2 libraries (jQuery UI and AngularJS) to improve the score.

Improve Accessibility score on Settings: Workflow edit page by ensuring ARIA ids are unique

The current Accessibility score for the Settings: Workflow edit page is 78. I would like to improve this by ensuring ARIA ids are unique to prevent other instances from being overlooked by assistive technologies.