Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.46 KB

README.md

File metadata and controls

40 lines (33 loc) · 1.46 KB

VLAIO NETWORK

The backend for the VLAIO visualisation project. The project uses Django and PostgreSQL.

Starting the project

Before starting the project, make sure Docker and docker-compose are installed.

docker-compose up -d --build

The startup script will:

  • Make and run all Django migrations
  • Insert mock data

To stop:

docker-compose down

API endpoints

The API for this project was build using Django Rest Framework.

The following endpoints have been created:

  • api/companies
    • Print all companies
  • api/partners
    • Print all partners
  • api/interactions
    • Print all interactions between companies and partners
  • api/interactions?name=example
    • Print all interactions between a company and a certain partner (by partner name)
  • api/interactions/types
    • Print all interaction types (i.e. subsidie,begeleiding,financiering,..)
  • api/overlap
    • Print the interaction overlap between partners (endpoint for upset plot)
    • param: limit (limits the overlaps for beter performance)
  • api/overlap/filter
    • Endpoint for filtering the interaction overlaps (endpoint for upset plot)
    • params: timeframe (between interactions in weeks), type (interaction type), limit
  • api/upload
    • endpoint for uploading excel files (in progress)
  • api/view
    • endpoint for sunburst chart