Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.39 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.39 KB

IMLS grant funded project(PresQT) to build Preservation Quality Tools and RESTful Services to Improve Preservation and Re-use of Research Data & Software. More info at https://presqt.crc.nd.edu/ and https://osf.io/d3jx7/

General Technical Documentation

Please see our ReadTheDocs documentation page.

Development Partners

Developer Setup

Prerequisites

  • Local installation of Docker for Mac/Windows/Linux
  • Knowledge of setting environment variables
  • Knowledge of docker-compose utility.

To bring up a local version of PresQT, take the following steps:

  1. Clone the repo to your local machine.
  2. Export the following ENV_VARS:
    • ENVIRONMENT: Should be either production or development
    • SECRET_KEY: A Django "secret key" value.
  3. Execute docker-compose -f docker-compose-development.yml up within the repo's base folder.
  4. Navigate to http://127.0.0.1:8000/api_v1/ or http://localhost:8000/api_v1/ in your browser or a service like Postman.