README.md 3.36 KB
Newer Older
Roberto Minelli's avatar
Roberto Minelli committed
1
# Mímir – A Visual Browser for the Federal Archives
Roberto Minelli's avatar
Roberto Minelli committed
2

3
Mímir is a visual platform to explore the [Swiss Federal Archives](https://www.bar.admin.ch/bar/en/home.html). It aggregates the results according to the [archive plan](https://www.recherche.bar.admin.ch/recherche/#/en/search/archive-plan) and uses [Voronoi treemaps](https://pubsys.mmsp-kn.de/pubsys/publishedFiles/BaDe05b.pdf) to portray the result (i.e., an algorithm to represent hierarchies as nested polygons).
Roberto Minelli's avatar
Roberto Minelli committed
4

5
In Mímir, users enter simple and advanced text queries (e.g., metadata, content, reference code, country) to find documents of interest. Mímir queries the archives using the [SFA Data Search API](https://www.recherche.bar.admin.ch/recherche/#/en/information/api), aggregates the results according to their archive plan context, and generates an interactive visualization. User can expand and collapse nodes or request additional pieces of information about documents of interest.
Roberto Minelli's avatar
Roberto Minelli committed
6
7

This project is a submission to the [SFA Data Challenge](https://www.bar.admin.ch/bar/en/home/research/searching/project-online-access.html).
Roberto Minelli's avatar
Roberto Minelli committed
8

Roberto Minelli's avatar
Roberto Minelli committed
9
10
[![Mímir in a Nutshell](/assets/screenshots/mimir-ui-sample.png)](http://www.youtube.com/watch?v=wKFd5wOgjSk "Click to watch a demo video!")

Roberto Minelli's avatar
Roberto Minelli committed
11

Roberto Minelli's avatar
Roberto Minelli committed
12
13
14
15
16
17
## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

18
To install Mímir and its dependencies, you need to have [NPM.js](https://www.npmjs.com) installed. NPM.js a package manager for the JavaScript programming language.
Roberto Minelli's avatar
Roberto Minelli committed
19

Roberto Minelli's avatar
Roberto Minelli committed
20
To install it, please refer to the [official installation guide](https://www.npmjs.com/get-npm).
Roberto Minelli's avatar
Roberto Minelli committed
21

Roberto Minelli's avatar
Roberto Minelli committed
22
### Installing Mímir
Roberto Minelli's avatar
Roberto Minelli committed
23

Roberto Minelli's avatar
Roberto Minelli committed
24
Below you find step by step instructions on how to get a development environment up and running.
Roberto Minelli's avatar
Roberto Minelli committed
25

Roberto Minelli's avatar
Roberto Minelli committed
26
1. Navigate to the `api` folder, install its dependencies with NPM, and start the server:
Roberto Minelli's avatar
Roberto Minelli committed
27
28
29
30
31
32
33

```
cd api
npm install
npm run dev
```

Roberto Minelli's avatar
Roberto Minelli committed
34
2. Navigate to the `client` folder, install its dependencies with NPM, and start the client:
Roberto Minelli's avatar
Roberto Minelli committed
35
36
37
38
39
40
41

```
cd client
npm install
npm start
```

Roberto Minelli's avatar
Roberto Minelli committed
42
3. Open your browser on [`http://localhost:3000/`](http://localhost:3000/) and try Mímir.
Roberto Minelli's avatar
Roberto Minelli committed
43
44
45

## Try it out!

Roberto Minelli's avatar
Roberto Minelli committed
46
The online version of Mímir is available at [`https://mimir.si.usi.ch/`](https://mimir.si.usi.ch/)
Roberto Minelli's avatar
Roberto Minelli committed
47
48
49

## Built With

Roberto Minelli's avatar
Roberto Minelli committed
50
- [SFA Data Search API](https://www.recherche.bar.admin.ch/recherche/#/en/information/api)
Roberto Minelli's avatar
Roberto Minelli committed
51
52
53
54
55
56
- [React Redux](https://react-redux.js.org/)
- [React Bootstrap](https://react-bootstrap.github.io/)
- [d3.js](https://d3js.org/)

## Authors

Roberto Minelli's avatar
Roberto Minelli committed
57
58
59
60
61
- **Aron Fiechter** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/) // [](mailto:aron.fiechter@usi.ch?subject=Information%20about%20Mímir)
- **Federico Pfahler** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/) // [](mailto:federico.pfahler@usi.ch?subject=Information%20about%20Mímir)
- **Davide Paolo Tua** // [CodeLounge](https://codelounge.si.usi.ch/) @ [Software Institute](https://si.usi.ch/) // [](mailto:davide.paolo.tua@usi.ch?subject=Information%20about%20Mímir)
- **Dr. Roberto Minelli** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/) // [](mailto:roberto.minelli@usi.ch?subject=Information%20about%20Mímir)
- **Prof. Michele Lanza** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/) // [](mailto:michele.lanza@usi.ch?subject=Information%20about%20Mímir)