actes-princiers/README.md

# Actes princiers

The research project "Actes princiers in the Kingdom of France (14th-16th centuries)" aims to gather and edit the acts produced by the chancelleries of various French princes and princesses of royal blood from the 14th and 15th centuries. This mostly unpublished collection aims to shed light on the interactions between the power strategies of the princes of the Late Middle Ages and the methods of writing used by their chancelleries.

The project is led by the Western Medieval Studies Laboratory of Paris (Paris 1/CNRS), and supported by the Historical Research Center (CNRS/EHESS), the Jean Mabillon Center (National School of Paleography) and the National Archives of France. It received funding from the LabEX HASTEC in 2023.

---

## Installation process

This process describes how to install and run the project locally, e.g. for development purposes.

_Nota_ : commands to execute through the terminal (Linux or macOS)

- Clone the repo : `git clone https://gitlab.huma-num.fr/jgenero/actes-princiers`
- Install the virtual environment:
  - Check that you’re using Python 3.x version by running : `python --version` (>3.8 required);
  - Go to the following directory  : `cd actes-princiers`;
  - Install the environment : `python3 -m venv .venv`.
  - Install the packages and libraries :
    - Activate the environment  : `source bootstrap.sh`;
    - Installation : `pip install -r requirements.txt`
    - Create database: `flask db init`;
    - Exit the environment : `deactivate`;

## Data processing

When data is changed (e.g. XML files or CSV files), the following command must be ran :

- `flask db init` to recrete the DB from the XML files (from _static/xml_).

## Launch
  
- Activate the environment : `source bootstrap.sh`;
- Launch : `flask run`;
- Go to http://127.0.0.1:5000/;
- Stop : `ctrl + c`;
- Exit the environment : `deactivate`.