Quickstart
To self host Mprove use README.md
Sign Up
After signing up, you will be able to log in and create an organization.
Create Organization
To create a new organization, click the org selector in navbar and click the New Org button.
Enter your organization name and click Create.
Create Project
To create a new project, first select your organization in navbar.
Click the project selector in navbar and click the New Project button.
Enter your project name and click Create.
Add Project API Keys
Click the project gear icon in navbar and click the API Keys button.
Add Sandbox Provider api key
Add LLM Provider api key or use OpenAI Codex Setup
Add Connection
To create a new database connection, first select your project in navbar.
Click the project gear icon in navbar and click the Connections button.
On the Project Connections page, click the New Connection button.
Enter your connection details and click Create.
Ask AI to Setup Mprove Project
Click the Builder in navbar.
Toggle Editor Session.
Ask "Setup mprove project and use malloy types"
Explore created Model in UI
On the Models page, click on the model selector and select the model you created.
Click the Schema tab.
Select the measure and dimension from the schema.
Save the draft chart as a new chart file.
Save your drafts as files for later use
All charts, reports, and dashboards in Draft status are deleted during the repository validation process.
If you save a draft as a file, it is no longer a draft and will not be deleted during the repository validation process.
Repository validation process is triggered whenever a user manually edits files in their Dev repository or performs Git-related actions in either the Dev or Production repository.
For example, when a user with the FilesEditor role pushes new changes to the Production repository, this Git-related action deletes all drafts for all users in the Production repository.
Keep this in mind when planning how often to push changes to production.
Commit changes
On the Files page, review the changes that need to be committed.
Click Commit button.
Enter a commit message (optional) and click Commit.
Push changes to Production
On the Files page, review the changes that need to be Pushed to Production.
Click Push to Production button.
Switch to Production Repository
Click the repoName-branchName selector in navbar and select production/main branch.
Check that the chart you created is visible on the Models page in the Charts section.