digitallinguistics / data-explorer

The DLx portal for viewing, searching, and aggregating data

DLx Organization Profile

This repository contains the code for the Digital Linguistics (DLx) profile page.

data-explorer's Issues

set up Handlebars

Set up Handlebars for templating.

set up LESS

Set up LESS.

Help Menu

Add a Help Menu (modeled after the one in the Lotus app). This will be separate from the Account Menu, sitting right next to it in the main navigation. Name this the #help-nav and the main nav #main-nav.

• What's New
• Visit the Q&A
• Request a Feature
• Report an Issue

Languages Page

Add a Languages page.

add issue templates

• request a feature
• report a problem
• update links in Help Menu to use these templates
• update contributor doc to use those templates

About Page

Add an About page, and a link to the Main Nav for it. For now the only content will be an <h1> header that says "About".

set up unit tests

Set up unit tests.

support language descriptions

The user should be able to edit the description page for each language.

set up Node project

Create the Node project by adding a package.json file.

add development database

Add a fake database (with real data) to use during development.

add pull request template

Add a pull request template.

Text Explorer

Features

• adjustable line height
• highly visible list of glossing abbreviations
• #15

Lexemes Page

Add a table view of lexical entries.

Resources

• Google Drive API Reference

Examples

• Harvest reports
• Harvest invoices
• GitHub issues
• WALS (especially for the Languages List)

Home Page

Add a Home page, which for now also covers the contents of an About page.

deploy `main` branch to dev server

Deploy the main branch to the dev server.

set up Zenodo

• turn on repository syncing
• make an initial release
• add Zenodo information to readme (badge)
• add Zenodo DOI to citation in readme
• add Zenodo information to CITATION.cff

set up alternate domains

Alternate domains:

• explore.digitallinguistics.io
• explorer.digitallinguistics.io
• oxalis.digitallinguistics.io

set up nodemon

Set up nodemon (but add nodemon.json to .gitignore).

create server

Add a basic server that returns the text "Oxalis" to every request.

add 404 handler

Blocked by #42.

Add a 404 handler. It should just return the text "404: Not Found".

master > main

Rename master branch to main.

support data versioning

Researchers should be able to publish versions of their data, and each version should live at a stable URL. Versions can be accessed using querystrings. If the querystring is missing, the latest version is used.

permission editing for projects

Blocked by #298.

The user should be able to edit permissions for a project.

Also handle the case where a user wants to remove themselves from a project. (Disallow this if they're the only admin.)

add 5xx handler

Blocked by #42.

Add a 5xx handler and error page, with a link to open an issue.

Dictionaries page

Add a Dictionaries page and a link in the Main Nav.

For now the only content will be an <h1> tag that says "Dictionaries".

contributing docs

• Add documentation for contributors.
• Add project principles.
  • any relevant principles from Lotus
  • principles of data citation (especially stable URLs)
  • support for mobile devices
  • optimized for speed, but not offline use or cached data
• #120
• unit vs. E2E tests
• project structure
• build tools (nodemon, ESLint, Mocha + Chai)
• context that should be passed to every page:
  • title
  • [title]: true
• look at Lotus' contributing doc for coverage
• look at GitHub's guidance on contributing docs
• look at your contributing checklist

support data import

The user should be able to import data to a language (this way the data is automatically associated with that language).

add citation file

Add a CITATION.cff file to this repo.

About Page: stats

Show stats on the number of registered users, number of languages, texts, etc. etc.

add site banner

Add a main banner to the site (which should be hidden on data explorer pages).

set up Auth0

Set up Auth0.

add static routing

• Add routing for static files using express.static.
• Call the static folder assets/ rather than public/.
• Move the files from the icons/ folder into the assets/images folder, then delete the icons/ folder.
  • assets/images/icons/oxalis.png ❌
  • assets/images/oxalis.png ✅

set up Application Insights

Set up Application Insights.

add Projects Page

Add a Projects page, and a link to the Main Nav.

For now the only content will be an <h1> header that says "Projects".

create main layout

Create the main layout / shell for the site.

update readme

• add badges
• add explainer for Oxalis and its acronym (Online Explorer for Linguistic Scholarship)

permission editing for languages

Blocked by #298.

The user should be able to edit permissions for a language.

Also handle the case where a user wants to remove themselves from a language. (Disallow this if they're the only admin.)

set up Cypress tests

Set up Cypress testing for frontend.

• test: page navigation
• update contributor docs

support project descriptions

The user should be able to edit the project description, in Markdown.

Encourage users to provide contact information.

add test for correct year in license

Add a unit test for the correct year in the license.

Semantic Domains Explorer

Describe the solution you'd like

The user should be able to browse a (hierarchical) list of semantic domains, pulling up a filtered list of all lexical entries for that domain.

Wish List

• Include an option to show pictures, so that someone can click on a lexical entry by its picture (especially useful for ethnobotanical and ethnobiological entries).

install stop-only

Install stop-only to prevent tests with .only() from being committed to main.

run tests on CI

Blocked by #36 or #40.

Run tests on PRs and pushes to main.

set up ESLint

Set up ESLint.

user login

Allow the user to log in to the site.

You might be able to use Azure's built-in authentication service.

To Do

• Set up federated identity login using Azure.
• Add tests for login / logout link.
• Create a user component with logged in / logged out states.
• Render the component as appropriate based on a flag passed to the local context.

Resources

• Brown's book Web development with Node and Express
• Using multiple identity providers
• Tutorial

add main nav

Add a main navigation bar for the site at the top of the main layout.

support multilingual highlighting in texts

Describe the solution you'd like
The user should be able to enable multilingual highlighting for a text (or possibly for the app, or for a specific corpus / project, or some combination thereof). This would highlight any words in the text marked as being a language other than the primary language of the text. If there are more than two languages in the text, each additional language should receive a different (accessible) color.

To make this maximally accessible, there should also be an option to indicate different languages via various styles of underlining (single, double, dotted, slashed, etc.).

create Azure application

• Create an Azure application.
• Set up custom domains:
  • data.digitallinguistics.io
  • explore.digitallinguistics.io
  • oxalis.digitallinguistics.io
  • explorer.digitallinguistics.io

user logout

Allow the user to log out of the site.

add security middleware (helmet)

Add security middleware (helmet).