ManuScrape is a solution for managing large amounts of observations (images mapped to custom defined parameters), including tools to collect, edit, enrich and export.
This is the main ManuScrape repo which holds the native client side windows/mac/linux app.
If you are looking for the backend repo, go to the manuscrape_nuxt repository.
There are two main actors: the project manager and the collaborator.
Project managers can setup projects using the web app:
- Enter project name
- Define observation parameters
- Invite collaborators by email
Collaborators can submit observations using the native app:
- Capture image (using smart tools or file upload)
- Edit image
- Enter observation parameter values
- Attach extra files if any
- Submit observation
Whether you're a collaborator or project owner isn't bound to your ManuScrape user, but to your permission role in the specific project.
The project manager can export the entire project into to different formats, including spreadsheets and zip files. Right now the export features are optimized to deliver formats, that are easy to import into NVivo 14.
Before you start installing, you need to decide where you want to put your data. As of now, you can temporarily use app.manuscrape.org for free, which is also the default option in the signup flow.
You can also use another instance of the manuscrape backend, either by a third party provider, or in your own organization. You choose which backend to use, by specifying the URL in the sign-up and sign-in flow.
You can download a windows installer, that will either install or update the ManuScrape client to the desired version. The latest .exe installer can be found here.
We intend to use GitHub Issues for all development tasks. If you experience bugs, or need features added or refactored, please submit an issue, preferably in english.
You are more than welcome to contribute to the project in any way. Except donations. For now.
This repo is an Electron app tested on Windows 11 and a couple Linux distributions. The app provides native client tools, that talks with the api of the Nuxt app. Here is the Nuxt repo.
Make your contributions the way you think works best. Please branch out from the branch named "unstable", which contains the newest version.
These instructions covers installation of a completely local setup, on all three major platforms. However, on Windows, the npm scripts will only work on Git Bash.
- Install Python and NodeJS (and Git Bash on Windows)
- Install Electron repository:
git clone https://github.com/nikobojs/manuscrape_electroncd manuscrape_electronnpm installnpm run pyinstall(on Windows:npm run pyinstall-win)npm run pyfreeze(on Windows:npm run pyfreeze-win)
- Install ManuScrape Nuxt repository
- Start Nuxt app:
cd manuscrape_nuxt && yarn dev - Start Electron app:
cd manuscrape_electron && npm start(on Windows:npm run start-win) - For MacOS: If you have problems with taking screenshots after the installation, go to System Preferences -> Privacy & Security -> Screen Recording, and give app permission