[ 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 ]

Production make check-prod

Development make check-dev

│

▼

[ ENVIRONMENT_SETUP ]

make setup-env

click to view configuration details

Authentik Configuration
Variable	Required	Default	Auto-generation method	Description
AUTHENTIK_PORT	❌	9000	-	Port on which Authentik server will listen
AUTHENTIK_HOST	❌	localhost	-	Hostname for the Authentik service in the Docker network
AUTHENTIK_BOOTSTRAP_EMAIL	❌	admin@localhost	-	Email for the admin user
AUTHENTIK_SECRET_KEY	✅	-	openssl rand -base64 60 | tr -d '\n'	Secret key for JWT token generation
AUTHENTIK_ADMIN_PASSWORD	✅	-	openssl rand -base64 16	Password for the admin user
AUTHENTIK_ADMIN_TOKEN	✅	-	openssl rand -hex 32	API token for the admin user
AUTHENTIK_CLIENT_ID	✅	-	Via Authentik API	Client ID for the backend service
AUTHENTIK_CLIENT_SECRET	✅	-	Via Authentik API	Client secret for the backend service
PG_USER	❌	authentik	-	PostgreSQL user
PG_DB	❌	authentik	-	PostgreSQL database name
PG_PASS	✅	-	openssl rand -base64 36 | tr -d '\n'	PostgreSQL password for Authentik database
Backend Configuration
BACKEND_PORT	❌	8000	-	Port on which the FastAPI backend service will listen
BACKEND_HOST	❌	localhost	-	Hostname for the backend service in the Docker network
DATABASE_URL	❌	sqlite:///./app/database/mycelium.db	-	SQLite database connection string for the application
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

For complete configuration options, refer to .env.example

│

▼

[ LAUNCHING.. ]

make launch

click to view individual service commands

make auth Authentication

make front Frontend

make back Backend

│

▼

[ CONTRIBUTION_PROTOCOL ]

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