The UI platform for E-Ark
Clone or download
Pull request Compare This branch is 1 commit ahead, 32 commits behind magenta-aps:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

EARK Platform UI

EARK Platform UI is a collection of tools for searching and accessing archival information. These tools are presented in a single-page web application that uses the EARK Python Bridge for a backend.

The Access Tools include multiple modules:

  • Search module
  • Order management
  • IP viewing

The modules are all available in the same web user interface (UI) and the UI requires login to access. Logged in users will have different access permissions based on role. End users can only access the search module and IP viewing for IPs made available to them. Archivists have unrestricted access to all the modules.

Get up and running

We assume you already have EARK Python Bridge installed and running as a backend. Read the docs to learn more. We also assume you have Node.js and NPM installed and running.

  1. Clone the GitHub project. You can do it with a terminal command:
$ git clone
  1. Wire the EARK Platform UI to the backend by changing the proxy settings in the gulpfile.js.

  2. Browse to the project folder and build the project using npm and gulp:

/E-Ark-Platform-UI/$ npm update
/E-Ark-Platform-UI/$ npm install
/E-Ark-Platform-UI/$ gulp build
  1. Set up hosting for your project files and point it to /E-Ark-Platform-UI/index.html

  2. Open a web browser and point it to the URL where your project is hosted. Consult your backend provider to get usernames and passwords for login.

Learn more

Read the documentation for this project to learn more about customization options like adding translations.