Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 4.14 KB

README.md

File metadata and controls

103 lines (67 loc) · 4.14 KB
Raw

Production frontend of Den okände von Wright, vonwright.sls.fi

This branch contains the production frontend app of the digital edition Den okände von Wright, https://vonwright.sls.fi/. It is based on digital-edition-frontend-ng, the frontend app of the SLS platform for building digital edition web apps.

The app is built on Angular and uses Ionic web components.

Angular version badge   Ionic version badge

Changelog

Learn about the latest improvements.

Documentation

Development Setup

Prerequisites

  1. Install Node.js which includes npm. The app is compatible with Node ^18.19.1, ^20.11.1 and ^22.0.0. The app is currently configured to run on Node 20. Check your Node version with:
Node --version
  1. Install the Angular CLI globally:
npm install -g @angular/cli

  1. Clone the repository locally and cd into the folder. On Windows you can use GitHub Desktop or Git Bash (see tutorial on Git Bash).

  2. Install dependencies:

npm install

Running locally

Development Server

To build and serve the application on a development server as a client-side app only, run:

npm run start

Open your browser on http://localhost:4200/. The app will automatically rebuild and reload if you change any of the source files.

Server-Side Rendered App

To build the server-side rendered application, run:

npm run build:ssr

Then, to serve the app, run:

npm run serve:ssr

Open your browser on http://localhost:4201/. You need to manually run the build and serve commands again for changes in the source files to take effect.

About the SLS Digital Edition Platform

The platform consists of an Angular frontend app, a Flask-driven REST API, a backend search app run by the Elastic (ELK) Stack, a template for a backend files repository and a database template. There is also a tool for creating commentaries to texts in TEI-XML format.