An open API service indexing awesome lists of open source software.

https://github.com/thm-graphs/atag-editor

Web editor for texts using the Applied Text as Graph (ATAG) model
https://github.com/thm-graphs/atag-editor

Last synced: 4 months ago
JSON representation

Web editor for texts using the Applied Text as Graph (ATAG) model

Awesome Lists containing this project

README

        

# Web-based Editor for texts using the [Applied Text as Graph](https://git.thm.de/aksz15/atag) concept

## Demo

The static page demonstrates the editor core functionalities:
https://thm-graphs.github.io/atag-editor/

This version does not always reflect the latest changes of the development process. To get a full version of the app running, follow the instructions of the next chapter.

## Installation

1. If you are using Windows, make sure [Windows Subsystem for Linux](https://learn.microsoft.com/de-de/windows/wsl/install) (WSL), [Docker Desktop](https://www.docker.com/) and [Node.js](https://nodejs.org/en/download/package-manager) (in WSL) are installed.

2. Open a command line tool (e.g. Ubuntu), select a directory, clone the repo and move into it.

```sh
cd
git clone https://github.com/THM-Graphs/atag-editor.git
cd atag-editor
```

3. Copy the `.env.example` file to create your `.env` file.

```sh
cp .env.example .env
```

**Afterwards, replace the placeholder values with actual values.**

4. Install dependencies in your hosts's server and client folder.

```sh
(cd server && npm install)
(cd client && npm install)
```

5. Build docker containers and run the app

```
docker compose up -d
```

**Please be patient, Neo4j takes its time. Wait approx. 1 minute**.

You can now access the editor and the database:

- Editor start page with text overview: http://localhost:5173
- Neo4j database: http://localhost:7474