davidkopp / flying-dutchman

Flying Dutchman 12

General information

This is the repository for the development of the project "Flying Dutchman" of group 12 at Uppsala University in the masters course User Interface Programming I.

Team members:

• David Kopp
• Paarth Sanhotra
• Rosemary Lima
• Abdullah Abdullah

Coordination

We use a WhatsApp group for quick communication and the GitHub project board for the organization of the tasks: https://github.com/davidkopp/flying-dutchman/projects/1

Development Setup

We use EditorConfig to apply some configuration across various editors and IDEs.

Recommended setup:

• Editor: VS Code
• Linting Tool: ESLint
• Server: VS Code Live Server
• Unit Tests: Jasmine

Enable ESLint:

npm install --save-dev eslint
npm install --save-dev eslint-plugin-jasmine
npm install --save-dev eslint-plugin-jsdoc

Run Unit Tests:

Open SpecRunner.html in your browser.

File Headers:

We have to add a file header to every file. You can use the VS Code extention psioniq File Header to automatically add a header to every new file and to update the headers of files you edit. The template is placed in the workspace settings: .vscode/settings.json.

To set the author information you can add the following to your user settings (change author, initials and authorEmail):

"psi-header.config": {
    "forceToTop": true,
    "blankLinesAfter": 1,
    "author": "David Kopp",
    "initials": "DK",
    "authorEmail": "[e-mail]",
    "creationDateZero": "blank"
}