Set up ESLint with Airbnb Style Guide

.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "env": {
+    "browser": true,
+    "node": true,
+    "mocha": true,
+    "es2021": true
+  },
+  "extends": [
+    "airbnb-base",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "import",
+    "@typescript-eslint",
+    "mocha"
+  ],
+  "rules": {
+    // Your custom rules here
+    "no-console": "warn", // Example rule
+    "mocha/no-exclusive-tests": "error" // Example Mocha rule
+  }
+}

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: ci
+
+on:
+  push:
+    branches: "*"
+  pull_request:
+    branches: "main"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - name: "checkout repository"
+      uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        cache-dependency-path: '/home/runner/work/footnote/footnote/footnote-backend'
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - name: "Install dependencies"
+      working-directory: '/home/runner/work/footnote/footnote/footnote-backend'  
+      run: npm ci
+    - name: "Build project"
+      working-directory: '/home/runner/work/footnote/footnote/footnote-backend'
+      run: npm run build --if-present
+    - name: "Run tests"
+      working-directory: '/home/runner/work/footnote/footnote/footnote-backend'
+      run: npm test

.gitignore

@@ -0,0 +1,11 @@
+# Ignore node modules, environment variables
+
+# root directory
+node_modules/
+README-mia.md
+
+# footnote-backend directory
+footnote-backend/node_modules
+footnote-backend/.env
+footnote-backend/config/ca-certificate.crt
+

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "java.compile.nullAnalysis.mode": "automatic",
+    "eslint.validate": ["javascript", "typescript"],
+    "eslint.alwaysShowStatus": true
+}

DeveloperGuidelines.md

@@ -0,0 +1,77 @@
+# Developer Guidelines
+
+## How to obtain the source code
+
+The source code of footnote can be found in its public [gitHub repository](https://github.com/miahuynhh/footnote).
+
+## The layout of Footnote's directory structure
+
+### frontend
+
+```
+footnote-frontend
+├── public # Reusable actions, e.g., navigating, opening, creating entities
+├── pages # Website pages
+├── components # Reusable React components across scenes
+├── hooks # Reusable React hooks
+└── routes # Route definitions
+```
+
+### backend
+
+```
+footnote-backend
+├── routes # All API routes
+│ ├── api # API endpoints
+│ └── auth # Authentication routes
+├── config # Database configuration
+├── services # Services (e.g., S3)
+└── test # Test helpers
+```
+
+## How to build the software
+
+First, clone the remote repository by running this command on the command line:
+`git clone git@github.com:miahuynhh/footnote.git`
+You should now see a local `footnote` directory. From that root `footnote` directory, run the following commands:
+`npm run install-all` # to install all dependencies in the `footnote`, `footnote-backend`, and `footnote-frontend` folders
+`npm run build` # to build the frontend; this command is commonly used for deployment, can skip this command during development
+`npm start` # to start the backend server (on port 3000) and the frontend app (on port 5173) concurrently
+
+## How to test the software
+
+Ensure that all necessary packages are installed - i.e. run `npm install-all` from the root directory.
+For backend testing, ensure that the proper database configurations are in place - the correct .env file in the root directory, and the ca-certificate.crt file in the config directory in the footnote-backend directory.
+For backend testing - navigate to the footnote-backend directory.
+For frontend testing - navigate to the footnote-frontend directory.
+Ensure that the `test` folder is present within the directory, then run the following from the terminal:
+
+```
+npm test
+```
+
+## How to add new tests
+
+Navigate to the `test` directory - either in footnote-backend or footnote-frontend - and write tests using [Mocha](https://mochajs.org/) and the default node `assert` library, either by adding to an existing file with the `.mjs` extension, or by creating a new one. For a new file, import the assertion library:
+
+```
+import * as assert from 'assert';
+```
+
+## How to build a release of the software
+
+Run an appropriate command from the following to update the version:
+`npm run version:patch` # for a patch update
+`npm run version:minor` # for a minor update
+`npm run version:major` # for a major update
+These commands increments the version in `package.json`, commit the change, and tag the commit with the new version.
+
+Perform sanity checks on the version update:
+`npm run build` # to build the frontend to ensure it’s ready for deployment
+`npm test` # to run the test suite to confirm all tests pass
+`npm start` # to start the backend server (port 3000) and frontend app (port 5173) concurrently to verify they function together as expected
+Also ensure that the git tag generated by the versioning command matches the intended version.
+
+After reviewing the version update, push it to the remote repository:
+`git push` # push the version update
+`git push --tags` # push the version update tag

UserManual.md

@@ -0,0 +1,55 @@
+# User Manual
+
+## A high-level description
+
+Footnote is a tool designed to help dancers and choreographers digitally notate, visualize, and
+share their routines with ease. Whether you’re a beginner or a seasoned dancer, Footnote makes it
+easy to organize and document choreography in a much more efficient way than traditional methods.
+Footnote's key feature allows a user to leave detailed notes on specific timestamps in their dance
+video.
+
+## How to install the software
+
+You need an internet connection and a web browser, Chrome is recommended. There are no further system prerequisites to use Footnote.
+
+## How to run the software
+
+Navigate to `https://footnote.us/` to use Footnote.
+
+## How to use the software
+
+The initial page will be a login page where you can enter your username and password if you have an account with Footnote already. If it is your first time using Footnote, you can click the 'Click Here!' to create an account. This will direct you to a page where you can create a username and a password and confirm your password. Once your account is created, you will be directed to the login page to log into your account you jsut made.
+
+After successfully giving your username and password, you will be directed to the projects home page. Here, you will be able to see all the different projects you have previously made displayed in a board view. If a previously made project is clicked on, it will open the project page for that project. You will also have the button to create a new projects. If the create new project button is clicked, you will be directed to a blank project page.
+
+The project page has three main sections.
+
+1. The top left quadrant includes the video, with the play/pause button and scrubber to move the current time in the video.
+2. The botton left quadrant will include the annotation functions. This includes a text box where you can write the annotaitons for the video and the timestamp where the video is paused. There are also four buttons above the text box. This includes a plus button for creating a new annotation at the current timestamp, a pencil button to edit the currently selected annotation, a checkmark to save the current annotation at the selected timestamp, and lastly, a trash can to delete the selected annotation.
+3. The right half of the screen will include a list of all of the previously made annotations in chronological order, displaying the timestamp and text for each annotation. This list will be blank when creating a new project and will populate with annotations as annotations are created and saved with the checkmark in the bottom left section of the screen.
+
+At the intitial page when creating a new project, the annotation list on the right side and video section on the top left of the screen will be blank. The video screen on the left will have a button to upload a video, and when clicked, will take you to a pop-up screen to upload your desired dance video to annotate dance moves.
+
+## How to report a bug
+
+Internally, we will be using the [issues](https://github.com/miahuynhh/footnote/issues) tab in our github repository. This allows us to keep track of bugs being reported and address them right away. We can even tag people who have worked on that portion of the code. After the bug has been addressed, the issue will be closed. However, we will still have a history of bugs which helps us keep track of “known bugs” and allows us to better fix bugs that may arise in the future.
+
+As for bug reporting, we will be following some of the tips mentioned in the bug writing guidelines from Mozilla
+
+        1.  First, please describe the expected behavior (how our website should work) and the actual behavior. 
+
+        2.  Indicate whether you can reproduce the bug, and if so, please outline the steps you will take.
+
+            a.  Additionally, anyone who reports a bug should copy and paste the error that they are getting in the issue description. This allows people to get a bigger picture of the error and makes it easier for developers to look for solutions on their own. 
+
+            b.  It would be good to note whether this occurs every time or if it is an intermittent issue. 
+
+        3.  You should also indicate any steps that you have already taken, so that other developers know what to rule out. 
+
+        4.  Other information to include would be type of device, operating system, and browser. 
+
+After reporting the bug, it’s important to follow up so that this is addressed in a timely manner.
+
+## Known bugs
+
+We will be documenting our “known bugs” in our Readme.md file in our github repository. This will include a section called “Troubleshooting,” which will list common bugs and their behavior as well as the exact steps to fix the bug.