Commit e4847a5a authored by Roberto Minelli's avatar Roberto Minelli
Browse files

Working on About

parent 5fcc6a62
# Mìmir
# Mímir
## A Visual Browser for the Federal Archives
A Voronoi-based visualizer to explore the [Swiss Federal Archives](https://www.bar.admin.ch/bar/en/home.html). This project is a submission to the [SFA Data Challenge](https://www.bar.admin.ch/bar/en/home/research/searching/project-online-access.html)
Mímir is a visual platform to explore the [Swiss Federal Archives](https://www.bar.admin.ch/bar/en/home.html). It organizes the results according to the [archive plan](https://www.recherche.bar.admin.ch/recherche/#/en/search/archive-plan) and uses Voronoi treemaps to portray the result (i.e., an algorithm to represent hierarchies as nested polygons).
Users can query the Swiss Federal Archives with simple and advanced text queries. Mímir will show the results in a visualization and enable users to interact with it in various ways, for example by expanding and collapsing nodes or by requesting additional pieces of information about documents of interest.
This project is a submission to the [SFA Data Challenge](https://www.bar.admin.ch/bar/en/home/research/searching/project-online-access.html).
## Getting Started
......@@ -8,15 +13,15 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
What things you need to install the software and how to install them
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.
- [NPM.js](https://www.npmjs.com) - Please refer to the [official installation guide](https://www.npmjs.com/get-npm).
To install it, please refer to the [official installation guide](https://www.npmjs.com/get-npm).
### Installing
### Installing Mímir
A step by step series of examples that tell you how to get a development environment running
Below you find step by step instructions on how to get a development environment up and running.
Navigate to the `api` folder, install its dependencies with NPM, and start the server:
1. Navigate to the `api` folder, install its dependencies with NPM, and start the server:
```
cd api
......@@ -24,7 +29,7 @@ npm install
npm run dev
```
Navigate to the `client` folder, install its dependencies with NPM, and start the client:
2. Navigate to the `client` folder, install its dependencies with NPM, and start the client:
```
cd client
......@@ -32,11 +37,11 @@ npm install
npm start
```
Open your browser on [http://localhost:3000/](http://localhost:3000/) and try Mìmir.
3. Open your browser on [`http://localhost:3000/`](http://localhost:3000/) and try Mímir.
## Try it out!
mir is available at [http://mimir.si.usi.ch/](http://mimir.si.usi.ch/).
The online version of Mímir is available at [`http://mimir.si.usi.ch/`](http://mimir.si.usi.ch/)
## Built With
......@@ -46,12 +51,8 @@ Mìmir is available at [http://mimir.si.usi.ch/](http://mimir.si.usi.ch/).
## Authors
- **Aron Fiechter** - [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
* **Federico Pfahler** - [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
* **Davide Paolo Tua** - [CodeLounge](https://codelounge.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
* **Dr. Roberto Minelli** - [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
* **Prof. Michele Lanza** - [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
- **Aron Fiechter** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
- **Federico Pfahler** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
- **Davide Paolo Tua** // [CodeLounge](https://codelounge.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
- **Dr. Roberto Minelli** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
- **Prof. Michele Lanza** // [REVEAL](https://reveal.si.usi.ch/) @ [Software Institute](https://si.usi.ch/)
No preview for this file type
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment