impresso-frontend

Welcome to the impresso app frontend website to search, explore and create personal collections from the 40 millions (and counting!) newspapers articles of the impresso collection.

Application Structure

This repository contains three independent Vue 3 applications:

• Main App (/app/): The primary application for searching, exploring, and managing collections
• Widget App (/widget/): A standalone sharing widget for embedding content
• Institutions Access App (/institutions-access/): A dedicated application for institutional authentication and access

Each application has its own independent routing and can be built and deployed separately.

Install for development

This is a website that uses vue3. To install the dependencies, run:

npm install

If required, cnfigure Vue proxy to api and socket.io in .env.development. Do not put any slash at the end of the env variables:

VITE_MIDDLELAYER_API="https://...."
VITE_MIDDLELAYER_API_PATH="/api"
VITE_MIDDLELAYER_API_SOCKET_PATH="/api/socket.io"

To use vue proxy while developing, add this env variable to your .env.development.local file:

VITE_USE_PROXY_MIDDLEWARE=true

Finally run with:

npm run dev

AI Coding Assistant Configuration

This project includes configuration files for AI coding assistants to help maintain consistency and follow project conventions:

• .github/copilot-instructions.md: Instructions for GitHub Copilot
• .cursorrules: Instructions for Claude (Cursor IDE) and other AI assistants

These files contain important information about:

• Project structure and architecture
• Vue 3 composition API patterns
• TypeScript conventions
• Component development guidelines
• i18n usage patterns
• Storybook story conventions

When working with AI coding assistants, these configurations ensure generated code follows the project's established patterns and conventions.

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run serve

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

# run unit tests
npm run unit

# run e2e tests
npm run e2e

# run all tests
npm test

For a detailed explanation on how things work, check out the guide and docs for vue-loader.

Project

The 'impresso - Media Monitoring of the Past' project is funded by the Swiss National Science Foundation (SNSF) under grant number CRSII5_173719 (Sinergia program). The project aims at developing tools to process and explore large-scale collections of historical newspapers, and at studying the impact of this new tooling on historical research practices. More information at https://impresso-project.ch.

License

Copyright (C) 2020 The impresso team. Contributors to this program include: Daniele Guido, Thijs van Beek, Paul Schroeder, Roman Kalyakin. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU Affero General Public License for more details.