Developer GuidesHome

Developer guides

FlowInquiry is an application consisting of two components: a front-end and a back-end. Each component can be hosted on a separate service. To run the FlowInquiry application, both the front-end and back-end must be deployed properly.

The developer guidelines provide foundational knowledge for those contributing to the FlowInquiry codebase. If you encounter issues with the FlowInquiry codebase and the documentation doesn’t resolve them, feel free to raise an issue in our GitHub repository.

FlowInquiry’s source code, primarily written in Java, TypeScript, and Python, is platform-independent. However, some scripts are written in Bash and are supported in Bash-enabled environments such as macOS and Linux. If you’re using Windows, please enable Bash support by using one of the following options:

  • Windows Subsystem for Linux (WSL)
  • Cygwin
  • Linux Virtual Machine
ℹ️

We do not provide support for Windows-specific issues or any additional tools that are not used by our development team

Development tools

We strive to use the best tools to enhance our team’s productivity. Below are the tools we use in our development process

Docker: We use Docker to run external components like the PostgreSQL database and to build Docker images for FlowInquiry’s front-end and back-end

Powered by FlowInquiry

© 2024 The FlowInquiry Project.