Skip to content

ejolly/svelteturk

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

SvelteTurk

GitHub version docs site

🚧 Work in Progress 🚧

SvelteTurk is a desktop application for interacting with Amazon's Mechanical Turk service (e.g. creating HITs, contacting workers, getting HIT and Assignment meta-data etc). Designed to be a lightweight and simple tool for managing Mturk without the need to write any code, setup any servers, databases, etc. The goal of the project is to offer a modern graphical alternative to something like PsiTurk.

Getting Started

Check out the official docs and website for full instructions on how to install SvelteTurk and use it. No coding required!

Reporting bugs

If you do find any issues or would like to request new features open any issue on github. Please attach your log file to any bug reports you open. You find the location of your log file under the SvelteTurk Data Store section on this page.

Contributing

SvelteTurk is happy to take contributions from the community! Feel free to open pull-requests with changes to the code and/or checkout the public development roadmap on Trello.


Information for contributors and developers

More information coming soon...

Project structure

  • main/
    • contains code for the electron server, the skeleton html file that svelte renders to, and nedb files
  • renderer/
    • contains all code for the svelte app (e.g. pages and components)

Development Log

  1. Install npm (if you don't have it)
  2. Install entr brew install entr on macOS
  3. Bootstrap electron-forge starter npx create-electron-app svelte-turk
  4. Install dependencies and devDependencies: cd svelte-turk && npm install --save-dev electron-reload eslint eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-svelte3 prettier rollup rollup-plugin-livereload rollup-plugin-postcss rollup-plugin-node-resolve rollup-plugin-svelte rollup-plugin-terser rollup-plugin-commonjs svelte concurrently @fullhuman/postcss-purgecss postcss postcss-load-config svelte-preprocess tailwindcss
  5. Configure tailwind and postcss using this guide
  6. Launch the app with npm run start

Icons are sourced from hero icons and tabler icons

Packaging and releases

  1. Make sure you have github cli tools brew install gh
  2. npm run package
  3. Application will be generated in out/SvelteTurk-darwin-x64.zip
  4. Upload to github: gh release create vX.X.X out/SvelteTurk-darwin-x64.zip
  5. Or optionally run npm run release to do everything

Documentation development log

  1. Install tools: npm install -g docsify presite serve
  2. Create folder for documentation source files: mkdir docs-dev
  3. Configure presite to build to a docs folder: "presite": { "outDir": "docs" } to package.json
  4. Configure npm run commands to scripts in package.json: "docs-dev": "docsify serve docs"
  5. Launch live server to develop docs with npm run docs

The following additional steps are deprecated

  • "docs-dev": "docsify serve docs-dev"
  • "docs-build": "rm -r docs && presite docs-dev --wait 10000 && touch docs/.nojekyll"
  • Generate static files for hosting docs with npm run docs-build
  • (Optional): test that pre-rendered static doc files look ok serve docs

Note on hot-reloading

electron-reload is configured to just watch the renderer directory (i.e. Svelte) and will auto-refresh to any changes made to the svelte code. entr is used to restart the entire electron server on any changes to the main.js file which is the main electron process ("server").

If you encounter issues in which changes to the front-end svelte code are not updating the app it's likely because you have an orphaned rollup process running in the background. Just use your favorite method (e.g. ps aux | grep rollup, procs, etc) to find it and kill it and then relaunch the app.

About

Desktop Electron app for managing Amazon Mturk HITs, Assignments, and Workers

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published