[ MYCELIUM ]

[LICENSE]
[METRICS]
[UTILS]	DOCS   |   BUGS   |   FEATURES
[DESCRIPTION]	A powerful platform designed to simplify the creation and management of Data Contracts, bridging systems for seamless data ingestion.

│

▼

[ CORE_FEATURES ]

> AI-Powered Contracts Auto-generate data contracts using advanced LLM technology	> Fast Ingestion Automated configuration and streamlined pipeline setup
> Smart Visualization Track contracts and map data sources in real-time	> Team Collaboration Unite teams with centralized contract management

│

▼

[ DEPENDENCY_CHECK ]

Check Dependencies make check

click to view check details

make check-prod Production Dependencies

make check-dev Development Dependencies

│

▼

[ ENVIRONMENT_SETUP ]

make setup

click to view configuration details

Variable	Default	Description
API Configuration
API_PORT	8000	Port on which the FastAPI backend service will listen
API_HOST	localhost	Hostname for the FastAPI backend service
Database Configuration
POSTGRES_SOCKET		Path to the PostgreSQL socket directory (preferred if both socket and host/port are set)
POSTGRES_PORT	5432	Port number for PostgreSQL database connection (used if socket is not set)
POSTGRES_HOST	localhost	Hostname for the PostgreSQL database (used if socket is not set)
POSTGRES_USER	admin	PostgreSQL username for database authentication
POSTGRES_PASSWORD	(generated)	PostgreSQL password for database authentication
POSTGRES_DB	mycelium_db	Name of the PostgreSQL database
Keycloak Configuration
KC_PORT	8081	Port number for Keycloak server
KC_HOST	localhost	Hostname for the Keycloak server
KC_BOOTSTRAP_ADMIN_USERNAME	admin	Keycloak administrator username
KC_BOOTSTRAP_ADMIN_PASSWORD	(generated)	Keycloak administrator password
KC_MANAGEMENT_PORT	9000	Keycloak management port
KC_REALM	mycelium	Name of the Keycloak realm
KC_CLIENT_ID	(generated)	Client ID for Keycloak authentication
KC_GOOGLE_CLIENT_ID	-	Optional client ID for Google authentication
KC_GOOGLE_CLIENT_SECRET	-	Optional client secret for Google authentication
Frontend Configuration
FRONTEND_PORT	8080	Port on which the Vue.js frontend will be served
FRONTEND_HOST	localhost	Hostname for the frontend service in the Docker network
NGINX_LOG_LEVEL	error	Logging level for Nginx reverse proxy

│

▼

[ LAUNCHING.. ]

make launch Launch All Services

click to view individual service commands

make front or make front-dev Frontend (Production/Development)	make back or make back-dev Backend (Production/Development)
make launch-dev Launch All Services in Development Mode

│

▼

[ CLEANING.. ]

make clean

click to view individual cleaning commands

make clean-front Clean Frontend Docker Resources

make clean-back Clean Backend Docker Resources

│

▼

[ CONTRIBUTION_PROTOCOL ]

Fork Fork the repository	Branch git checkout -b feat/YourFeature	Code Implement your feature	Commit git commit -m 'Add feature'
Test make test	Push git push origin feat/YourFeature	Pull Request Open a PR on GitHub	Discuss Engage in review process