Skip to content

Archaeological Field Recording App by the German Archaeological Institute and the Head Office of the GBV Common Library Network

License

Notifications You must be signed in to change notification settings

dainst/idai-field

Repository files navigation

iDAI.field | Field

latest release Manual

Field is a modern take on flexible field and find recording for archaeological excavations. It is developed as a cooperation between the German Archaeological Institute (DAI) and the Head Office of the GBV Common Library Network (GBV). Field is completely Open Source and free to use!

For an overview of the genesis and the idea behind Field, check out one of our latest articles:

S. Hohl – T. Kleinke – F. Riebschläger – J. Watson, iDAI.field: developing software for the documentation of archaeological fieldwork, AeC 34, 1, 2023, 85–94, doi: 10.19282/ac.34.1.2023.10.

Using Field, archaeologists can:

  • record, share and store all data and images produced on the excavation
  • customize their own data model on top of a minimal shared model as defined by Field
  • locate all of their records on a map
  • manage types and inventories
  • sync & publish their excavation data

Information for developers and collaborators

This is a monorepo containing five packages:

  • Field Desktop: The Field Desktop application based on Angular and Electron
  • Field Mobile: The Field Mobile application based on React Native (early development, no release yet)
  • Field Hub: The (optional) synchronisation server application.
  • Field Core: Shared TypeScript modules
  • iDAI.field Web: The iDAI.field Web publication platform

Usage

Please refer to the wiki.

Development

The repository uses lerna to manage sub-package dependecies. When first checking out the code base, bootstrap the dependencies with:

$ npm run bootstrap

Refer to the sub-package READMEs for detailed instructions on how to set up individual development environments.