https://github.com/rockefellerarchivecenter/cartographer_backend

Backend for Cartographer app
https://github.com/rockefellerarchivecenter/cartographer_backend

django project-electron

Last synced: 1 day ago
JSON representation

Backend for Cartographer app

• Host: GitHub
• URL: https://github.com/rockefellerarchivecenter/cartographer_backend
• Owner: RockefellerArchiveCenter
• License: mit
• Created: 2019-12-12T14:56:42.000Z (almost 5 years ago)
• Default Branch: base
• Last Pushed: 2024-11-06T20:30:29.000Z (10 days ago)
• Last Synced: 2024-11-06T21:30:40.015Z (10 days ago)
• Topics: django, project-electron
• Language: Python
• Size: 726 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cartographer_backend

An Django application which provides a backend API to manage JSON tree representations of all archival collections, sub-collections, and parts (record group, subgroup, series, subseries, etc.) by a designated agent/creator ("arrangement maps" for short).

cartographer_backend is part of [Project Electron](https://github.com/RockefellerArchiveCenter/project_electron), an initiative to build sustainable, open and user-centered infrastructure for the archival management of digital records at the [Rockefeller Archive Center](http://rockarch.org/).

## Local Development

Install [git](https://git-scm.com/) and clone the repository

    $ git clone https://github.com/RockefellerArchiveCenter/cartographer_backend.git

With [Docker](https://store.docker.com/search?type=edition&offering=community) installed, run docker-compose from the root directory

    $ docker-compose up

Once the application starts successfully, you should be able to access the application in your browser at `http://localhost:8000`

When you're done, shut down docker-compose

    $ docker-compose down

Or, if you want to remove all data

    $ docker-compose down -v

### Routes

| Method | URL | Parameters | Response  | Behavior  |

|--------|-----|---|---|---|

|GET|/maps|`modified_since` - returns only maps modified since the time provided (as a Unix timestamp) 
`published` - if present, returns only published maps|200|Returns a list of maps, ordered by most recent first|

|GET|/delete-feed|`deleted_since` - returns only maps deleted since the time provided (as a Unix timestamp)|200|Returns a list of deleted maps, ordered by most recent first|

|GET|/status||200|Returns the status of the application|

## Development

This repository contains a configuration file for git [pre-commit](https://pre-commit.com/) hooks which help ensure that code is linted before it is checked into version control. It is strongly recommended that you install these hooks locally by installing pre-commit and running `pre-commit install`.

## License

This code is released under an [MIT License](LICENSE).