Vessel Connections

Overview

A web application for monitoring and simulating vessel ballasting systems. The system allows users to visualize and analyze connections between various marine vessel components (tanks, pumps, valves, pipes, and sea inlets/outlets) through an interactive interface.

Features

• Interactive valve control system
• Real-time connection analysis between vessel components
• Multi-user support for independent system interaction
• Dynamic vessel model generation from configuration files
• Visual representation of equipment connections

Technology Stack

• Backend:
  • FastAPI for the Python backend API.
    • SQLModel for ORM-based SQL database interactions.
    • Pydantic for data validation and settings management.
    • PostgreSQL as the SQL database.
• Frontend:
  • React with TypeScript, hooks, and Vite for a modern frontend stack.
    • Chakra UI for UI components.
    • Generated client for consuming the backend API.
• Authentication:
  • JWT (JSON Web Token) authentication.
• Testing:
  • Pytest for backend testing.

Explore the API documentation at http://127.0.0.1:8000/docs.

How to Run it!

Backend

createdb <dbname>
# Set the environment variables in the .env file
cd backend
poetry install
# Run ./prestart.sh to run db migrations and load vessel settings
poetry run ./prestart.sh 
poetry run uvicorn src.main:app --reload

Frontend

cd frontend
npm install
npm run dev