Developer documentation

This documentation is designed for developers working in ArchivesSpace. Full Emory documentation for ArchivesSpace is in the aspace-deployment github repository.

To set up a local development environment using Docker, follow the steps in the ArchivesSpace tech-docs github repository. To add Emory’s plug-ins to your local instance, follow the steps outlined in the ArchivesSpace plug-ins documentation.

For getting started with ArchivesSpace, the following documentation may be helpful:

• Main ArchivesSpace Github repository (core code)

• Technical overview

• Resources for developers

• API documentation

• API reference

• Data model overview

• Installing, configuring, and maintaining an ArchivesSpace instance (see the customization and theming section)

Github

All code related to Emory’s instance of ArchivesSpace is maintained in Github:

• aspace-deployment: deployment configuration for ArchivesSpace and processes for deployments with Lyrasis

• aspace_static_plugins: local customizations and configurations for ArchivesSpace

API access

Emory maintains two API users for developers: developer_1_api and developer_2_api. They have read/write access and are associated with the Sharepoint email for LTDS.

Emory also maintains a read-only API user for Curate called curate_api.

Credentials for these users are in the division 1Password account so the LTDS division can share them.