Skip to content

QutEcoacoustics/interaction-experiments

Repository files navigation

interaction-experiments

Netlify Status

This repo contains a set of interaction experiments the QUT Ecoacoustics lab runs to test new ideas.

Each experiment is designed for it's own purpose and must have an associated ethics document before they "go-live".

Importantly, however, experiments that are in devleopment, or no longer needed are still contained here, and may even still work in production but will be prevented from storing any of the collected data.

Install instructions

  1. Clone this repo
  2. Open a shell (PowerShell on Windows, Bash on Mac or Linux)
  3. cd to this directory
  4. Install Hugo https://gohugo.io/getting-started/installing/

Testing instructions

  1. In your shell, run the hugo server command
  2. Edit files in this folder, and see the changes live at http://localhost:1313/
  3. Use Ctrl+c to stop the Hugo server
  4. Commit and and Push your changes
  5. Wait about 30 seconds and they will be live in production

Testing data submission

  1. Ensure a recent version of Node is installed, preferably the same version as is in netlify.toml
  2. Install netlify-cli: npm install -g netlify-cli
  3. Link netlify-cli to Netlify: netlify link
  4. Ensure the expected environment variables are set in the Netlify site settings not in the netlify.toml config file
    • these settings are managed by the repository admin
  5. Run netlify dev to simulate a netlify deploy
  6. Submit data from an experiment and change code as needed

Editing code

Please use Visual Studio Code to make changes to these files. Open this folder as a workspace and it will automatically suggest extensions to install.

Most importantly: do not mass format a file because you do not like how it is formatted. This can produce confusing diffs and unnecessarily large commits.

See .editorConfig and .eslintrc.yml for established style rules.

You don't need eslint installed. The files in the solution are already formatted well, so just try to maintain the style you see.

However, if you want to use the eslint extension, then:

  1. Ensure you have a revent version of node installed
  2. Install eslint with npm install -g eslint
  3. If your workspace is open, you will need to re-open it

About

Repo for hosted UI/UX interaction experiments

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •