Skip to content

MarcoSchaeferT/ICV-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dashboard

ICV Logo

ICV — Interactive Context-rich Views for Public Health Data

Open-source, composable web framework for creating release-ready public health emergency interfaces with context-rich, explainable views.

React Node 25.8 Next.js TypeScript Tailwind CSS Python 3.12 Flask API Docker 29.3 PostgreSQL D3 Leaflet Recharts

Run the tool

To run the tool execute the following command:

docker compose up

Build Dependencies

Note

If you want to further develop and/or build the tool yourself, the following dependencies are prerequisites: Node, Docker, and Python have to be installed -> see versions above.

#install packages
npm install

Local Development

Warning

Ensure that the docker service is running!

# run database & build + watch changes + run website 
npm run dev

page available at: http://localhost:3000 (see terminal log)

Note

or DB access and building the docker container there is an .env file at the root level of the repository where you can adjust the following content:

  • DATABASE_URL="postgresql://icv_user:<DB_PASSWORD>@icv-database:5333/icv-database?schema=public"
  • DATABASE_URL_SECRET="postgresql://icv_user:<DB_PASSWORD>@icv-database:5333/icv-database?schema=public"
  • DB_PASSWORD_SECRET="<DB_PASSWORD>"

To debug or develop the backend, use two terminals (one for the backend and one for the frontend and database):

# 1. terminal:
npm run flask-dev

# 2. terminal
npm run dev

Production Build

#Build your app: 
npm run build

#Run your app: 
npm run start

Docker

  • Dockerize the Application

    # build & run the application
    npm run docker
    • (optional) dev commands

      • start containers

        # only start the already build containers: 
        npm run docker-run
      • force a clean rebuild of the images and run containers

        # build & run
        npm run docker-noCache
      • individually build & run Docker containers

        #Build your containers: 
        docker compose build icv-database
        docker compose build icv-backend
        docker compose build icv-frontend
        
        #Run your containers (each in an individual terminal): 
        docker compose up icv-database
        docker compose up icv-backend
        docker compose up icv-frontend

Inspect the Database

# starts db & opens prisma studio 
npm run db-view

General Info

see also next.js_docu_deployment

License

This project is licensed under the GNU GPL-3.0 License - see the LICENSE file for details.

Copyright (c) 2026 ICV Contributors

Funding

This project is funded by the Federal Ministry of Health (BMG) under grant No. 2523DAT400 (project: AI-DAVis PANDEMICS)

Federal Ministry of Health Logo

For more information about the project and funding, see: AI-DAVis PANDEMICS

Third-Party Licenses

This project uses many open-source libraries and components. For a comprehensive list of all dependencies and their licenses, see DEPENDENCIES.md.

Key Dependencies Highlights:

  • Frontend: React, Next.js, Tailwind CSS (MIT/Apache-2.0)
  • Backend: Flask, NumPy, PostgreSQL drivers (BSD-3-Clause)
  • UI Components: Radix UI, Recharts, D3, Leaflet
  • Icons: Font Awesome (CC BY 4.0), Game Icons (CC BY 3.0)
  • Utilities: Swapy (GPL-3.0), Prisma (Apache-2.0)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors