maidr 1.0.0

package/.Rbuildignore

@@ -0,0 +1 @@
+^LICENSE\.md$

package/.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+other/

package/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": ["plugin:prettier/recommended"],
+  "parserOptions": {
+    "ecmaVersion": 13
+  }
+}

package/.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+      - name: Install dependencies
+        run: yarn install
+      - name: Build
+        run: yarn build

package/.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+other/
+dist/

package/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "endOfLine": "auto"
+}

package/.vscode/extensions.json

@@ -0,0 +1,25 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "github.vscode-github-actions",
+    "github.vscode-pull-request-github",
+    "visualstudioexptteam.vscodeintellicode",
+    "visualstudioexptteam.intellicode-api-usage-examples",
+    "ms-vscode.js-debug-nightly",
+    "ms-vsliveshare.vsliveshare",
+    "ionutvmi.path-autocomplete",
+    "esbenp.prettier-vscode",
+    "ban.spellright",
+    "redhat.vscode-xml",
+    "editorconfig.editorconfig",
+    "github.copilot",
+    "github.copilot-chat",
+    "usernamehw.errorlens",
+    "mhutchie.git-graph",
+    "eamodio.gitlens",
+    "ms-edgedevtools.vscode-edge-devtools",
+    "codium.codium",
+    "ms-vscode.vscode-speech"
+  ],
+  "unwantedRecommendations": ["ms-vscode.js-debug"]
+}

package/.vscode/settings.json

@@ -0,0 +1,30 @@
+{
+  "editor.stickyScroll.enabled": true,
+  "editor.stickyScroll.defaultModel": "foldingProviderModel",
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnType": true,
+    "editor.formatOnSave": true
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnType": true,
+    "editor.formatOnSave": true
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnType": true,
+    "editor.formatOnSave": true
+  },
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnType": true,
+    "editor.formatOnSave": true
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnType": true,
+    "editor.formatOnSave": true
+  },
+  "cmake.configureOnOpen": false
+}

package/.vscode/tasks.json

@@ -0,0 +1,57 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "yarn lint",
+      "type": "shell",
+      "command": "yarn lint",
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn build",
+      "type": "shell",
+      "command": "yarn build",
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn test",
+      "type": "shell",
+      "command": "yarn test",
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn docs",
+      "type": "shell",
+      "command": "yarn docs",
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.0.0] - 2023-11-01

package/CITATION.cff

@@ -0,0 +1,21 @@
+cff-version: 1.2.0
+message: 'If you wish to cite the "maidr" package use:'
+type: software
+license: GPL-3.0
+title: 'maidr: Multimodal Access and Interactive Data Representation'
+version: 1.0.0
+abstract: maidr: Multimodal Access and Interactive Data Representation. maidr is a system for non-visual access and control of statistical charts. It aims to provide an inclusive experience for users with visual impairments by offering multiple modes of interaction: braille, text, and sonification. This comprehensive  approach enhances the accessibility of data visualization and encourages a multi-model exploration on visualization.
+authors:
+- family-names: Seo
+  given-names: JooYoung
+  email: jseo1005@illinois.edu
+  orcid: https://orcid.org/0000-0002-4064-6012
+repository: https://github.com/uiuc-ischool-accessible-computing-lab/maidr
+repository-code: https://github.com/uiuc-ischool-accessible-computing-lab/maidr
+url: https://uiuc-ischool-accessible-computing-lab.github.io/maidr
+contact:
+- family-names: Seo
+  given-names: JooYoung
+  email: jseo1005@illinois.edu
+  orcid: https://orcid.org/0000-0002-4064-6012
+  

package/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to maidr
+
+Thank you for your interest in contributing to maidr project! We welcome contributions from everyone.
+
+## Pre-requisites
+
+To contribute to this project, you need to have the following installed on your local machine:
+
+1. git .
+
+1. node.js (version 16 or higher is recommended)
+
+1. npm (version 9 or higher is recommended)
+
+1. yarn
+
+1. [Visual Studio Code (VS Code)](https://code.visualstudio.com/) (recommended)
+
+## Getting Started
+
+To get started, please follow these steps:
+
+1. Fork the repository on GitHub.
+
+1. Clone your forked repository to your local machine.
+
+1. Open the project in VS Code.
+
+1. Install all the recommended extensions.
+
+1. install `npm` if you don't have it already.
+
+1. Install `yarn` if you don't have it already. You can install it by running the following command in your terminal:
+
+```shell
+npm install -g yarn
+``````
+
+1. In the forked project root, install the dependencies by running the following command in your terminal:
+
+```shell
+yarn install
+```
+
+1. Make changes.
+
+1. Run `yarn lint` to lint the code.
+
+1. Run `yarn build` to build the project.
+
+1. Run `yarn test` to run the tests.
+
+1. Run `yarn docs` to generate the documentation.
+
+1. Test the new features locally.
+
+1. Commit your changes and push them to your forked repository.
+
+1. Create a pull request to the main repository.
+
+* Note: If you are using VS Code, you can run the above commands (e.g., `yarn lint`, `yarn build`, `yarn test`, `yarn docs`) by pressing `Ctrl + Shift + B` (or `Cmd + Shift + B` on macOS) and selecting the command you want to run.
+
+## Guidelines
+
+Please follow these guidelines when contributing to the project:
+
+- Use JavaScript (es6) for all code.
+- Write clear and concise commit messages.
+- Follow the code style and formatting guidelines.
+- Write tests for new features and bug fixes.
+- Update the documentation as needed in `CHANGELOG.md`.
+
+## Code Style and Formatting
+
+We use ESLint to enforce a consistent code style and formatting. Please run `yarn lint` before committing your changes to ensure that your code meets the standards.
+
+## Tests
+
+We use Jest for unit testing. Please run `yarn test` before committing your changes to ensure that your changes do not break any existing tests.
+
+## Documentation
+
+We use jsdoc for documentation. Please update the relevant documentation in js files when making changes to the project.
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.