An open API service indexing awesome lists of open source software.

https://github.com/dainst/idai-field

Archaeological Field Recording App by the German Archaeological Institute and the Head Office of the GBV Common Library Network
https://github.com/dainst/idai-field

archaeology data-recording excavation

Last synced: 2 months ago
JSON representation

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

Awesome Lists containing this project

README

          

# iDAI.field | Field

[![latest release](https://img.shields.io/github/v/release/dainst/idai-field)](https://github.com/dainst/releases)
[![Manual](https://img.shields.io/badge/Manual-field.idai.world-green)](https://field.idai.world/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](https://www.dainst.org)) and the Head Office of the GBV Common Library Network ([GBV](https://en.gbv.de/)). Field is completely Open Source and free to use!

## About Field

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](https://doi.org/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 users and interested projects
We are always happy to hear about your Field projects! If you are using Field in your research, consider [signing up for the Field users mailing list](https://lists.fu-berlin.de/listinfo/idaifield2-user) ([idaifield2-user@dainst.de](mailto:idaifield2-user@dainst.de)), where you can exchange tips and tricks with other users and get updates about new releases. Feel free to also join in the [Discussions](https://github.com/dainst/idai-field/discussions) in this repository.

## Information for developers and collaborators

This is a monorepo containing six packages:

* [Field Desktop](desktop): The Field Desktop application based on Angular and Electron
* [Field Mobile](mobile): The Field Mobile application based on React Native (early development, no release yet)
* [Field Hub](server): The (optional) synchronisation server application.
* [Field Core](core): Shared TypeScript modules
* [iDAI.field Web](web): The [iDAI.field Web publication platform](https://field.idai.world)
* [Field Publication](publication): The new Field publication platform (in development, no release yet)

## Usage

Please refer to the [wiki](https://github.com/dainst/idai-field/wiki).

## Development

The repository uses [lerna](https://github.com/lerna/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.