add README file

Author: akinsibay

packages/api-gateway/README.md

@@ -1,6 +1,3 @@
-Unit that manages incoming client request and redirects relevant backend service. Moreover, has authentication module that check user information and generate JWT.  
+# /api-gateway
 
-Consists of:
-- Rate limiting
-- Helmet lib
-- Auth module
+Central api gateway to access all APIs safely and efficiently that manages incoming client request and redirects relevant backend service. Moreover, has authentication module that check user information and generate JWT.

packages/dockerize-api/README.md

@@ -1 +1,3 @@
-flow-dockerize-service
+# dockerize-api
+
+To ensure that different flows run in isolation and use system resources efficiently, each flow is given its own container when created. Every flow runs inside its own Docker container. All data related to that flow is stored in the database within that container. The container can be stopped or moved to another computer as needed. The purpose of this package is to manage this entire process.

packages/editor/README.md

@@ -1,11 +1,3 @@
-[![Netlify Status](https://api.netlify.com/api/v1/badges/b07708c8-4212-48c7-92d7-ee2239681363/deploy-status)](https://app.netlify.com/sites/oz-flowbuilder/deploys)
+# /editor
 
-# flow-builder-frontend
-
-Create .env file to root directory:
-
-```ini
-VITE_GATEWAY_CLOUD_URL = XXXX
-VITE_GATEWAY_LOCAL_URL = XXXX
-VITE_HOST_ENV= (development or production or test)
-```
+The frontend part of the application. All React components are found in this package. If you need to change the ports of the services in other packages, you need to update these ports in the .env file.

packages/entity-api/README.md

@@ -1,9 +1,3 @@
-This service consists of:
+# /entity-api
 
-- User module
-- Organization module (short-term)
-- Workspace module
-- Flow structure module
-- Studio structure module (long-term)
-- Team module
-- Permission module
+This service is responsible for handling the database communication for all entities in the application. It manages the database interactions for data like Users, Workspaces, Projects, Flows, Permissions, and Teams.

packages/flow-runtime/README.md

@@ -1 +1,3 @@
-flow-runtime service
+# /flow-runtime
+
+The core component for running Originzero flows. When a Docker container is started for each flow, a flow-runtime service is launched inside that container alongside a MongoDB service. This service is responsible for managing the database communication of flow elements (nodes and edges) and ensuring the entire flow algorithm runs correctly and concurrently.

packages/math-service/README.md

@@ -1 +1,3 @@
-Calculus service
+# /math-service
+
+The backend service for the Calculation node within the flows. It is designed to efficiently handle all types of mathematical operations, including complex calculations. When a Docker container is started for each flow, a math-service is also started for that flow.