├── .github ├── ISSUE_TEMPLATE │ └── config.yml ├── PR_Template.yaml └── workflows │ ├── ci.yaml │ └── cspell.json ├── .gitignore ├── .nvmrc ├── .vscode ├── extensions.json └── settings.json ├── LICENSE ├── README.md ├── babel.config.js ├── docs ├── about │ ├── index.md │ ├── licensing.md │ └── product-roadmap.md ├── api │ ├── generated-api-filtering.md │ ├── generated-api-pagination.md │ ├── generated-api-sorting.md │ ├── index.md │ └── metaquery-graphql.md ├── community │ └── handling-a-new-issue.md ├── concepts │ ├── assets │ │ ├── kafka-plugin.png │ │ ├── message-broker-creation-wizard.png │ │ ├── message-broker-plugins.png │ │ ├── message-broker-topics.png │ │ └── service-connections-tab.png │ └── event-driven-architecture.md ├── contributing.md ├── custom-code │ ├── add-action-to-controller.md │ ├── add-business-logic.md │ ├── add-custom-dto.md │ ├── add-graphql-query.md │ ├── amplicationignore.md │ ├── assets │ │ └── add-custom-dto │ │ │ ├── customer-type-filter-error.png │ │ │ ├── customer-type-filter.png │ │ │ └── customer-type-option-set.png │ ├── index.md │ ├── prisma-custom-attributes.md │ └── seed-a-db.md ├── dictionary │ └── en-custom.txt ├── doc1.md ├── errors │ ├── Installation-is-slow.md │ ├── assets │ │ └── prism-postgresql-access.png │ ├── could-not-authorize-user.md │ ├── github-different-app-id.md │ ├── index.md │ ├── installation-fails.md │ ├── invalid-code-generation-version.md │ ├── merge-conflict.md │ ├── missing-code-generation-version.md │ └── prisma-denied-access-on-postgres.md ├── faqs │ └── faqs.md ├── getting-started-v2 │ ├── example-services.md │ ├── intro-to-amplication.md │ └── quickstart.md ├── getting-started │ ├── Field-settings-dropdownlist.png │ ├── Field-settings.png │ ├── add-plugins-for-service.md │ ├── amplicationignore.md │ ├── assets │ │ ├── all-addons.png │ │ ├── all-plugins-and-categories.png │ │ ├── all-plugins.png │ │ ├── amplicationrc-json-plugin-settings.png │ │ ├── app-settings.png │ │ ├── authentication │ │ │ ├── auth-rest.png │ │ │ ├── delete_user_popup.png │ │ │ ├── disable_auth_plugin.png │ │ │ ├── new_user_entity.png │ │ │ └── plugin_installation_cannot_proceed.png │ │ ├── building-new-versions │ │ │ ├── compare-changes.png │ │ │ ├── new-build.png │ │ │ └── project-owner-due-date.png │ │ ├── client-secret.png │ │ ├── deploy │ │ │ ├── connect-to-git-provider.png │ │ │ ├── generated-app.png │ │ │ └── login.png │ │ ├── first-app │ │ │ ├── commit.png │ │ │ ├── created-entity.png │ │ │ ├── entities.png │ │ │ ├── granular-fields-2.png │ │ │ ├── granular-fields.png │ │ │ ├── granular-permissions.png │ │ │ ├── name-field.png │ │ │ ├── overview-window.png │ │ │ ├── pending-changes.png │ │ │ ├── permissions.png │ │ │ ├── roles.png │ │ │ └── task.png │ │ ├── first-service │ │ │ ├── admin-ui-graph-rest-api.png │ │ │ ├── amplication-home-page.png │ │ │ ├── authentication.png │ │ │ ├── data-model.png │ │ │ ├── database.png │ │ │ ├── generating-service.png │ │ │ ├── install-amplication-github-app.png │ │ │ ├── monorepo-polyrepo.png │ │ │ ├── select-repository.png │ │ │ ├── service-created-successfully.png │ │ │ ├── service-name.png │ │ │ └── sync-with-github.png │ │ ├── generated-app-api │ │ │ ├── graphql-playground.png │ │ │ └── swagger-ui.png │ │ ├── generated-app │ │ │ ├── admin-ui.png │ │ │ ├── app-components.png │ │ │ └── app-components2.jpg │ │ ├── granular-1.png │ │ ├── granular.png │ │ ├── import-prisma-schema-log.png │ │ ├── install-a-plugin.png │ │ ├── installed-plugins.png │ │ ├── new-database-plugin.png │ │ ├── overview-window.png │ │ ├── pic-1.jpg │ │ ├── pic-1.png │ │ ├── pic-2.jpg │ │ ├── pic-2.png │ │ ├── pic-3.jpg │ │ ├── pic-3.png │ │ ├── pic-4.jpg │ │ ├── pic-4.png │ │ ├── pic-5.jpg │ │ ├── pic-8.1.png │ │ ├── pic-8.png │ │ ├── pic-9.1.png │ │ ├── pic-9.png │ │ ├── pic0.png │ │ ├── pic11.jpg │ │ ├── pic11.png │ │ ├── pic13.jpg │ │ ├── pic13.png │ │ ├── pic8.1.png │ │ ├── pic8.jpg │ │ ├── plugin-settings.png │ │ ├── plugin-versions.png │ │ ├── prettier-plugin-settings-filled-in.png │ │ ├── project-structure.png │ │ ├── public-1.png │ │ ├── public1.png │ │ ├── relations │ │ │ ├── related-entity--1.jpg │ │ │ ├── related-entity--2.jpg │ │ │ ├── relation-cardinality.jpg │ │ │ └── self-relation-1.jpg │ │ ├── service-entities-roles-permissions │ │ │ ├── entities-from-overview.png │ │ │ ├── generated-code.png │ │ │ ├── github-pull-request.png │ │ │ ├── name-relations-field-from-user.png │ │ │ ├── service-entities-permissions.png │ │ │ └── specific-permissions-fields.png │ │ ├── smart-git-sync.svg │ │ ├── sync-with-git-provider │ │ │ ├── 1bb1238f-01a7-4650-aeb2-6f5ae8ae76c7.png │ │ │ ├── 32086706-520a-4996-8647-ecd81546f4f5.png │ │ │ ├── 495c5ae4-edae-4a8f-8338-09eaadc27998.png │ │ │ ├── 4b389970-6207-4010-b181-405806ff87c8.png │ │ │ ├── 4d38da6f-9b1c-4844-91ec-ec9b101c4503.png │ │ │ ├── 930b3e58-62e3-4b14-950c-13e11a41c878.png │ │ │ ├── 945389.png │ │ │ ├── Select-repository-2.png │ │ │ ├── amplication-bitbucket-consumer.png │ │ │ ├── amplication-commit-message.png │ │ │ ├── bitbucket-pull-request.png │ │ │ ├── build-log-message.png │ │ │ ├── commit-changes-and-build.png │ │ │ ├── commits-dropdown.png │ │ │ ├── commits-history.png │ │ │ ├── commits.png │ │ │ ├── dac2b208-365c-4bf4-9a49-f0914648cf8f.png │ │ │ ├── github-account-configuration-settings.png │ │ │ ├── github-code.png │ │ │ ├── github-pull-request-amplication-branch.png │ │ │ ├── github-pull-request.png │ │ │ ├── install_amplication.png │ │ │ ├── open-github.png │ │ │ ├── push-to-bitbucket.png │ │ │ ├── resource-overview.png │ │ │ ├── select-git-provider.png │ │ │ ├── select-repository.png │ │ │ ├── select-workspace.png │ │ │ ├── sync-with-git-provider.png │ │ │ └── sync-with-github.png │ │ ├── sync-with-github.svg │ │ ├── uninstall-auth-plugins.png │ │ ├── unistall-auth-plugins.png │ │ ├── view-code2a.png │ │ ├── view-code3.png │ │ ├── workspace1.png │ │ ├── workspace2.png │ │ ├── workspace3.png │ │ ├── workspace4.png │ │ ├── workspace5.png │ │ └── workspace6.png │ ├── authentication.md │ ├── beta-version.md │ ├── building-new-versions.md │ ├── cli.md │ ├── commit-changes-and-build-new-versions.md │ ├── community-plugins.md │ ├── configure-roles-and-permissions.md │ ├── deploy-docker-desktop.md │ ├── first-service.md │ ├── generated-app-api.md │ ├── generated-app.md │ ├── how-prisma-schemas-are-converted-into-entities.md │ ├── phone-home.md │ ├── plugins.md │ ├── projects.md │ ├── relations.md │ ├── service-entities-roles-permissions.md │ ├── set-up-entities.md │ ├── smart-git-sync.md │ ├── sync-with-aws-codecommit.md │ ├── sync-with-bitbucket.md │ ├── sync-with-git-diffrences-between-plans.md │ ├── sync-with-github.md │ ├── view-generated-code.md │ └── workspace-configuration.md ├── how-to │ ├── add-custom-code.md │ ├── add-custom-commits.md │ ├── add-delete-user-entity.md │ ├── amplication-ai-examples.md │ ├── amplication-ai.md │ ├── analytics-dashboard.md │ ├── api-adminui-settings.md │ ├── assets │ │ ├── amplication-ai │ │ │ ├── build-and-commit-project.png │ │ │ ├── create-actions.png │ │ │ ├── create-blog-service.png │ │ │ ├── create-entities.png │ │ │ ├── create-entity-fields.png │ │ │ ├── create-new-dto.png │ │ │ ├── create-new-module.png │ │ │ ├── create-new-project.png │ │ │ ├── implement-user-authentication.png │ │ │ ├── install-multiple-plugins.png │ │ │ ├── new-service.png │ │ │ ├── recommendations-for-plugins.png │ │ │ └── update-git-provider.png │ │ ├── amplication-analytics-dashboard.png │ │ ├── amplication-erd-view.png │ │ ├── amplication-platform-console.png │ │ ├── api-admin-ui-settings.png │ │ ├── authentication-entity.png │ │ ├── base-directories.png │ │ ├── code-generator-version-control.png │ │ ├── create-service-from-template.png │ │ ├── custom-actions.png │ │ ├── data-types.png │ │ ├── default-custom-attribute.png │ │ ├── download-code.png │ │ ├── entity-field-settings.png │ │ ├── field-settings.png │ │ ├── foreign-key.png │ │ ├── github-app-settings-page.png │ │ ├── install-amplication-github-app.png │ │ ├── live-service-templates │ │ │ ├── apis.png │ │ │ ├── complete.png │ │ │ ├── database.png │ │ │ ├── name-and-stack.png │ │ │ ├── platform-changes.png │ │ │ ├── publish.png │ │ │ ├── service-template-dashboard.png │ │ │ └── settings.png │ │ ├── message-broker-1.png │ │ ├── message-broker-2.png │ │ ├── message-broker-3.png │ │ ├── message-broker-4.png │ │ ├── message-broker-5.png │ │ ├── message-broker-6.png │ │ ├── npm-install.png │ │ ├── npm-server-install.png │ │ ├── pic-4.jpg │ │ ├── pic-5.2.png │ │ ├── pic-5.jpg │ │ ├── pic-6.png │ │ ├── pic-7.png │ │ ├── pic-7a.png │ │ ├── pic-8.png │ │ ├── pic-9.png │ │ ├── pic8.jpg │ │ ├── platform-changes.png │ │ ├── project-dashboard.png │ │ ├── public1.png │ │ ├── relation-entity.PNG │ │ ├── select-repository.png │ │ ├── service-catalog │ │ │ ├── above-grid-add-filter.png │ │ │ ├── card-view.png │ │ │ ├── code-view.png │ │ │ ├── commits.png │ │ │ ├── filter-view.png │ │ │ ├── grid-view.png │ │ │ ├── pending-changes-sidebar.png │ │ │ ├── pending-changes.png │ │ │ └── service-catalog.png │ │ ├── sso-login.png │ │ ├── template-name-and-stack.png │ │ ├── upload-prisma-schema-button.png │ │ ├── upload-prisma-schema.png │ │ ├── view-code1.png │ │ ├── view-code2.png │ │ ├── view-code2a.png │ │ └── view-code3.png │ ├── authentication-plugin-examples.mdx │ ├── base-directories.md │ ├── change-base-branch.md │ ├── choose-configure-update-database.md │ ├── code-generator-version-control.md │ ├── commit-changes.md │ ├── create-entity-field.md │ ├── create-entity.md │ ├── create-message-broker.md │ ├── create-service.md │ ├── default-value-entity-field.md │ ├── deploy-kubernetes.md │ ├── deploy-to-aws-ecs.md │ ├── deploy.md │ ├── enterprise-sso.md │ ├── erd-view-for-amplication-entities.md │ ├── git-branch-per-service.md │ ├── import-prisma-schema.md │ ├── index.md │ ├── live-service-templates.md │ ├── platform-console.md │ ├── resolve-github-connection-errors.md │ ├── run-dev-env.md │ ├── service-catalog.md │ ├── set-access-permissions.md │ └── understanding-break-the-monolith.md ├── platform-features │ ├── assets │ │ ├── alert-properties.png │ │ ├── alert-settings.png │ │ ├── alert-types.png │ │ ├── blueprints │ │ │ ├── blueprint.png │ │ │ ├── relations.png │ │ │ └── resource.png │ │ ├── resolve-technical-debt.png │ │ ├── service-level-technical-debt.png │ │ └── technical-debt-grid.png │ ├── blueprints.md │ └── technical-debt-management.md ├── plugins │ ├── assets │ │ ├── amplication-plugin-template.png │ │ ├── create-new-repo-from-template.png │ │ ├── events-hierarchy.drawio.svg │ │ ├── guides │ │ │ ├── another-database.png │ │ │ ├── choose-your-database.png │ │ │ └── db-settings.png │ │ ├── heirarchy.png │ │ ├── hierarchy.png │ │ ├── installed-plugins2.png │ │ └── private-plugins │ │ │ ├── add-new-plugin.png │ │ │ ├── add-new-version.png │ │ │ ├── add-private-plugin-to-service.png │ │ │ ├── configure-git-settings.png │ │ │ ├── dotnet-postgres-db.png │ │ │ ├── plugin-template.png │ │ │ ├── private-plugins-repo.png │ │ │ ├── publish-changes.png │ │ │ └── settings.png │ ├── before-after.md │ ├── context.md │ ├── define-plugin-settings.md │ ├── developing-a-plugin.md │ ├── dotnet-plugin-events-reference.md │ ├── dotnet-plugin-events │ │ ├── create-admin-dot-env.md │ │ ├── create-admin-git-ignore.md │ │ ├── create-admin-ui-package-json.md │ │ ├── create-admin-ui.md │ │ ├── create-connect-microservices.md │ │ ├── create-controller-base-module-file.md │ │ ├── create-controller-module-file.md │ │ ├── create-dtos.md │ │ ├── create-entity-controller-base.md │ │ ├── create-entity-controller-spec.md │ │ ├── create-entity-controller-to-many-relation-methods.md │ │ ├── create-entity-controller.md │ │ ├── create-entity-extensions.md │ │ ├── create-entity-grpc-controller-base.md │ │ ├── create-entity-grpc-controller-to-many-relation-methods.md │ │ ├── create-entity-grpc-controller.md │ │ ├── create-entity-interface.md │ │ ├── create-entity-model.md │ │ ├── create-entity-module-base.md │ │ ├── create-entity-module.md │ │ ├── create-entity-resolver-base.md │ │ ├── create-entity-resolver-to-many-relation-methods.md │ │ ├── create-entity-resolver-to-one-relation-methods.md │ │ ├── create-entity-resolver.md │ │ ├── create-entity-service-base.md │ │ ├── create-entity-service.md │ │ ├── create-message-broker-client-options-factory.md │ │ ├── create-message-broker-nest-j-s-module.md │ │ ├── create-message-broker-service-base.md │ │ ├── create-message-broker-service.md │ │ ├── create-message-broker-topics-enum.md │ │ ├── create-message-broker.md │ │ ├── create-prisma-schema.md │ │ ├── create-program-file.md │ │ ├── create-resource-db-context-file.md │ │ ├── create-seed-development-data-file.md │ │ ├── create-seed.md │ │ ├── create-server-app-module.md │ │ ├── create-server-appsettings.md │ │ ├── create-server-auth.md │ │ ├── create-server-csproj.md │ │ ├── create-server-docker-compose.md │ │ ├── create-server-git-ignore.md │ │ ├── create-server-secrets-manager.md │ │ ├── create-server.md │ │ ├── create-swagger.md │ │ └── load-static-files.md │ ├── dotnet-plugins.md │ ├── event-create-server.md │ ├── event-hierarchy.md │ ├── event-list.md │ ├── plugin-architecture.md │ ├── plugin-events │ │ ├── assets │ │ │ └── dbsettings.png │ │ ├── create-auth-module.md │ │ ├── create-entity-controller-base.md │ │ ├── create-entity-controller-spec.md │ │ ├── create-entity-controller.md │ │ ├── create-entity-resolver-base.md │ │ ├── create-entity-resolver.md │ │ ├── create-entity-service-base.md │ │ ├── create-entity-service.md │ │ ├── create-message-broker-client-options-factory.md │ │ ├── create-message-broker-nest-js-module.md │ │ ├── create-message-broker-nestjs-module.md │ │ ├── create-message-broker-service-base.md │ │ ├── create-message-broker-service.md │ │ ├── create-message-broker-topics-enum.md │ │ ├── create-message-broker.md │ │ ├── create-package-json.md │ │ ├── create-prisma-schema.md │ │ ├── create-seed.md │ │ ├── create-server-auth.md │ │ ├── create-server-docker-compose-db.md │ │ ├── create-server-docker-compose-dev.md │ │ ├── create-server-docker-compose.md │ │ ├── create-server-dot-env.md │ │ ├── create-server.md │ │ └── create-swagger.md │ ├── plugindev-overview.md │ ├── private-plugins.md │ ├── publish-your-plugin.md │ └── testing-a-plugin.md ├── premium-features │ ├── assets │ │ ├── break-the-monolith-ai-helper.png │ │ ├── break-the-monolith-confirm-architecture.png │ │ ├── break-the-monolith-overview-mode.png │ │ ├── break-the-monolith-redesign-mode.png │ │ ├── custom-types-and-actions │ │ │ ├── action-graphql.png │ │ │ ├── action-input-output-types.png │ │ │ ├── action-name-and-description.png │ │ │ ├── action-rest.png │ │ │ ├── add-module.png │ │ │ ├── all-actions.png │ │ │ ├── api-tab-overview.png │ │ │ ├── create-action.png │ │ │ ├── create-dto.png │ │ │ ├── delete-module.png │ │ │ ├── dto-name-and-description.png │ │ │ ├── dto-properties.png │ │ │ ├── edit-action.png │ │ │ ├── edit-disable-delete-dto.png │ │ │ └── edit-module.png │ │ └── enterprise-sync-with-git-providers.png │ ├── break-the-monolith.md │ ├── custom-base-branch.md │ ├── custom-types-and-actions.md │ ├── enterprise-git-providers.md │ └── private-plugins.md ├── running-amplication-platform │ ├── assets │ │ ├── amplication-auth-flow.png │ │ ├── app-settings.png │ │ ├── bitbucket-oauth-consumer-permissions.png │ │ ├── bitbucket-oauth-consumer-privacy.png │ │ ├── client-secret.png │ │ ├── connect-to-bitbucket.png │ │ ├── grant-access.png │ │ ├── register-new-bitbucket-oauth-consumer.png │ │ ├── register-new-github-app.png │ │ ├── register-new-oauth-app.png │ │ └── select-workspace.png │ ├── configure-github-auth.md │ ├── connect-server-to-bitbucket.md │ ├── connect-server-to-github.md │ └── index.md ├── tutorials │ ├── angular-todos │ │ ├── assets │ │ │ ├── step-001-001.png │ │ │ ├── step-002-001.png │ │ │ ├── step-002-002.png │ │ │ ├── step-002-003.png │ │ │ ├── step-002-004.png │ │ │ ├── step-002-005.png │ │ │ ├── step-002-006.png │ │ │ ├── step-002-007.png │ │ │ ├── step-002-008.png │ │ │ ├── step-002-009.png │ │ │ ├── step-002-010.png │ │ │ ├── step-002-011.png │ │ │ ├── step-002-012.png │ │ │ ├── step-002-013.png │ │ │ ├── step-002-014.png │ │ │ ├── step-002-015.png │ │ │ ├── step-002-016.png │ │ │ ├── step-002-017.png │ │ │ ├── step-003-001.png │ │ │ └── step-003-002.png │ │ ├── step-000.md │ │ ├── step-001.mdx │ │ ├── step-002.md │ │ ├── step-003.md │ │ ├── step-004.mdx │ │ ├── step-005.mdx │ │ └── step-006.mdx │ ├── assets │ │ └── amplication-youtube.png │ ├── community-tutorials.md │ ├── index.md │ └── react-todos │ │ ├── assets │ │ ├── step-001-001.png │ │ ├── step-002-001.png │ │ ├── step-002-002.png │ │ ├── step-002-003.png │ │ ├── step-002-004.png │ │ ├── step-002-005.png │ │ ├── step-002-006.png │ │ ├── step-002-007.png │ │ ├── step-002-008.png │ │ ├── step-002-009.png │ │ ├── step-002-010.png │ │ ├── step-002-011.png │ │ ├── step-002-012.png │ │ ├── step-002-013.png │ │ ├── step-002-014.png │ │ ├── step-002-015.png │ │ ├── step-002-016.png │ │ ├── step-002-017.png │ │ ├── step-003-001.png │ │ └── step-003-002.png │ │ ├── step-000.md │ │ ├── step-001.mdx │ │ ├── step-002.md │ │ ├── step-003.md │ │ ├── step-004.mdx │ │ ├── step-005.mdx │ │ └── step-006.mdx └── welcome.md ├── docusaurus.config.js ├── netlify.toml ├── package-lock.json ├── package.json ├── plugins └── analytics │ ├── analytics.js │ └── index.js ├── sidebars.js ├── src ├── css │ ├── custom.css │ └── dark-theme.css └── theme │ └── DocItem │ └── Footer │ ├── Feedback │ ├── index.js │ └── styles.module.css │ └── index.js └── static ├── global.js ├── img ├── amplication-docs-social-card.png ├── amplication-logo-dark.svg ├── amplication-logo.svg └── favicon.ico ├── robots.txt └── video ├── step-001-002.mp4 ├── step-004-001.mp4 ├── step-005-001.mp4 ├── step-006-001.mp4 └── step-006-002.mp4 /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: No issues undertaking 4 | url: https://github.com/amplication/amplication/issues/new/choose 5 | about: We are not tracking issues in this repo. To report an issue related to this repo, please open the issue on our main repo amplication/amplication 6 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: push 3 | jobs: 4 | check: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - name: Checkout 8 | uses: actions/checkout@v3 9 | with: 10 | fetch-depth: 1 11 | - name: Install dependencies 12 | run: npm install 13 | - name: CSpell 14 | run: npm run cspell -------------------------------------------------------------------------------- /.github/workflows/cspell.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.1", 3 | "language": "en", 4 | "dictionaries": [ 5 | "english" 6 | ], 7 | "dictionaryDefinitions": [ 8 | { 9 | "name": "english", 10 | "path": "../../docs/dictionary/en-custom.txt" 11 | } 12 | ], 13 | "flagWords": [ 14 | "hte" 15 | ], 16 | "ignoreRegExpList": [ 17 | "code-block", 18 | "html-video-element" 19 | ], 20 | "patterns": [ 21 | { 22 | "name": "code-block", 23 | "pattern": "/```([\\s\\S]*?)```/gm" 24 | }, 25 | { 26 | "name": "html-video-element", 27 | "pattern": "/^]*>/gm" 28 | } 29 | ] 30 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | /node_modules 3 | 4 | # Production 5 | /build 6 | 7 | # Generated files 8 | .docusaurus 9 | .cache-loader 10 | 11 | # Misc 12 | .DS_Store 13 | .env.local 14 | .env.development.local 15 | .env.test.local 16 | .env.production.local 17 | 18 | npm-debug.log* 19 | yarn-debug.log* 20 | yarn-error.log* 21 | 22 | dictionary.dic 23 | 24 | # Replit files 25 | replit.nix 26 | .replit -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 16.14 -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": ["streetsidesoftware.code-spell-checker"] 3 | } 4 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cSpell.dictionaryDefinitions": [ 3 | { 4 | "name": "custom", 5 | "path": "${workspaceFolder}/docs/dictionary/en-custom.txt" 6 | } 7 | ], 8 | "cSpell.dictionaries": ["custom", "wordsEn"], 9 | "cSpell.allowCompoundWords": true, 10 | "search.useIgnoreFiles": false, 11 | 12 | } 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | | 📝 **Note** | 4 | |------------| 5 | | Amplication Documentation moved to https://github.com/amplication/amplication-docs | 6 | 7 | # Amplication Documentation 8 | Welcome to the [Amplication documentation](https://docs.amplication.com/) repository! This repository contains the documentation for the Amplication open-source development platform. Amplication is a low-code development platform that allows developers to quickly build scalable and maintainable applications. 9 | 10 | The documentation provides detailed information on how to use the platform, including tutorials, guides, and reference material. 11 | This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. 12 | 13 | 14 | ## Installation 15 | 16 | ```console 17 | npm ci 18 | ``` 19 | 20 | ## Local Development 21 | 22 | ```console 23 | npm run start 24 | ``` 25 | 26 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. 27 | 28 | ## Build 29 | 30 | ```console 31 | npm run build 32 | ``` 33 | 34 | This command generates static content into the `build` directory and can be served using any static contents hosting service. 35 | 36 | ## Deployment 37 | 38 | ```console 39 | GIT_USER= USE_SSH=true npm run deploy 40 | ``` 41 | 42 | If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. 43 | 44 | # Contributing 45 | 46 | We welcome contributions to the Amplication documentation! If you find an issue or want to suggest an improvement, please [open a GitHub issue](https://github.com/amplication/amplication/issues/new/choose) and then submit a pull request. 47 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 3 | }; 4 | -------------------------------------------------------------------------------- /docs/about/product-roadmap.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: product-roadmap 3 | title: Product Roadmap 4 | sidebar_label: Product Roadmap 5 | slug: /about/roadmap 6 | --- 7 | 8 | # Product Roadmap 9 | 10 | View the official [Amplication roadmap](https://github.com/orgs/amplication/projects/11/views/1) 11 | 12 | As an open-source platform, Amplication is committed to a policy of complete transparency with our community about our future direction. Use our product roadmap to learn about our future plans, to see what we're working on and what's coming next. 13 | By sharing our roadmap, we hope you will become an even closer partner in our joint vision of building and extending a platform that will empower professional developers to create business applications. 14 | 15 | ## Give Feedback 16 | 17 | If you have thoughts, ideas or suggestions, about an item in the Amplication Public Roadmap, click **Edit** and leave a comment. 18 | 19 | ## Make a Contribution 20 | 21 | We hope that the roadmap will help you decide where you can [make a contribution](/contributing/) to the Amplication platform. If you see an item that you want to work on, whether it’s a feature, issue, or documentation, we would love to hear from you. 22 | 23 | ## Make a Feature Request 24 | 25 | If you have an idea for a feature that does not appear on the roadmap, you can open a [Feature Request](/contributing/#missing-a-feature). 26 | 27 | ## Disclaimer 28 | 29 | The Amplication Product Roadmap does not represent a commitment, guarantee, obligation, or promise to deliver any product or feature or to deliver any product and feature by any particular date. 30 | -------------------------------------------------------------------------------- /docs/api/generated-api-pagination.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: generated-api-pagination 3 | title: API Pagination 4 | sidebar_label: Generated API Pagination 5 | slug: /api/generated-api-pagination 6 | --- 7 | 8 | # Generated API Pagination 9 | 10 | The generated API comes with built-in support for Offset pagination. 11 | 12 | Offset pagination uses the `skip` parameter to exclude the first N items and the `take` parameter to define the number of items to be included on each page. 13 | 14 | :::note 15 | 16 | The `skip` and `take` parameters are available only on endpoints and queries that return a list of items. 17 | For example: `/api/posts` or `/api/posts/{id}/tags` 18 | ::: 19 | 20 | Pagination requires an implied ordering. This is determined by the `orderBy` parameter. For more information see [Generated API Sorting](../generated-api-sorting) 21 | 22 | ## Pagination Examples 23 | 24 | The following examples take items 21-40 from a list of blog posts (equals to 2nd page, in a list with 20 items per page). 25 | 26 | Skip=20 27 | 28 | Take=20 29 | 30 | ### REST API 31 | 32 | ``` 33 | curl -X 'GET' \ 34 | 'https://[server-url]/api/posts?skip=20&take=20' \ 35 | -H 'accept: application/json' 36 | ``` 37 | 38 | ### GraphQL 39 | 40 | ``` 41 | query{ 42 | posts( 43 | skip:20 44 | take:20 45 | ) 46 | { 47 | id 48 | title 49 | } 50 | } 51 | ``` 52 | -------------------------------------------------------------------------------- /docs/api/generated-api-sorting.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: generated-api-sorting 3 | title: API sorting 4 | sidebar_label: Generated API - Sorting 5 | slug: /api/generated-api-sorting 6 | --- 7 | 8 | # Generated API - Sorting 9 | 10 | The generated API comes with built-in support for sorting. 11 | 12 | Sorting uses the `orderBy` parameter, which accepts an object with the name of the fields. 13 | 14 | :::note 15 | 16 | - Amplication does not support sorting by fields of nested entities. 17 | 18 | - The `orderBy` parameter is available only on endpoints and queries that return a list of items. For example: `/api/posts` or `/api/posts/{id}/tags` 19 | 20 | ::: 21 | 22 | ## Sorting Examples 23 | 24 | The following examples get all posts sorted by the `createdAt` field. 25 | 26 | ### REST API 27 | 28 | ```jsx 29 | curl -X 'GET' \ 30 | 'https://[server-url]/api/posts?orderBy%5BcreatedAt%5D=asc' \ 31 | -H 'accept: application/json' 32 | ``` 33 | 34 | ### GraphQL 35 | 36 | ```jsx 37 | query{ 38 | posts( 39 | orderBy:{ 40 | createdAt:desc 41 | } 42 | ){ 43 | id 44 | title 45 | } 46 | } 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/api/metaquery-graphql.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: meta-query-graphql 3 | title: GraphQL Meta Queries 4 | description: Learn how to use GraphQL's EntitiesMeta API to obtain both the total record count and specific result counts for your queries. 5 | sidebar_label: GraphQL Meta Queries 6 | slug: /api/meta-query-graphql 7 | --- 8 | 9 | # Meta Query in GraphQL 10 | 11 | ## Obtaining the record count of a query 12 | 13 | You can use the `_EntitiesMeta API` to obtain the total record count of a query. The meta query supports all the parameters that are supported in the `FindMany` query. 14 | 15 | ```bash 16 | query{ 17 | _customersMeta(where:{ 18 | firstName:{ 19 | contains:"jack" 20 | } 21 | }){ 22 | count 23 | } 24 | } 25 | 26 | 27 | ``` 28 | This will return a JSON object with a single property: `count`, which represents the total number of records that match the query. 29 | 30 | ## Obtaining the result count of a query 31 | 32 | You can also use the meta query together with the `findMany` query to obtain the result count for a specific query. 33 | 34 | 35 | ```bash 36 | query customers($where: CustomerWhereInput, $orderBy: CustomerOrderByInput, $skip: Float, $take: Float) { 37 | items: customers(where: $where, orderBy: $orderBy, skip: $skip, take: $take) { 38 | id 39 | createdAt 40 | updatedAt 41 | firstName 42 | lastName 43 | __typename 44 | } 45 | total: _customersMeta(where: $where, orderBy: $orderBy, skip: $skip, take: $take) { 46 | count 47 | __typename 48 | } 49 | } 50 | ``` 51 | This query will return two objects: `items` and `total`. The `items` object contains an array of records that match the specified criteria, while the `total` object contains the total number of records that match the query, as determined by the `_customersMeta` meta query. -------------------------------------------------------------------------------- /docs/concepts/assets/kafka-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/concepts/assets/kafka-plugin.png -------------------------------------------------------------------------------- /docs/concepts/assets/message-broker-creation-wizard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/concepts/assets/message-broker-creation-wizard.png -------------------------------------------------------------------------------- /docs/concepts/assets/message-broker-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/concepts/assets/message-broker-plugins.png -------------------------------------------------------------------------------- /docs/concepts/assets/message-broker-topics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/concepts/assets/message-broker-topics.png -------------------------------------------------------------------------------- /docs/concepts/assets/service-connections-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/concepts/assets/service-connections-tab.png -------------------------------------------------------------------------------- /docs/custom-code/amplicationignore.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: managing-custom-files 3 | title: Managing custom files 4 | sidebar_label: Managing custom files 5 | slug: /custom-code/managing-custom-files 6 | --- 7 | 8 | # Managing Custom Files 9 | 10 | When you work with Amplication to generate code, Amplication re-generates the code without affecting your custom files. 11 | 12 | However, to allow you greater control, Amplication has provided the `.amplicationignore` file to ensure that selected files are ignored when a new Pull Request is created by Amplication. 13 | 14 | ## Using `.amplicationignore` to ignore your files 15 | 16 | Place the `.amplicationignore` file in the root of your repository and add any files you want Amplication to ignore during the code generation process. 17 | 18 | The file works similarly to `.gitignore`, using the [glob]() syntax. Here is an example: 19 | 20 | ```bash 21 | # .amplicationignore 22 | folder_or_file. <-- Ignore a specific file or folder 23 | folder/file <-- Ignore a specific file in a folder 24 | folder/**/file.json <-- Ignore all file.json occurrences in subfolders of "folder" 25 | ``` 26 | 27 | ## What happens to the changes? 28 | 29 | The files that are in `.amplicationignore`, when updated, will be saved in the `.amplication/ignored` folder inside the git repository. 30 | 31 | :::info 32 | Remember, as always with Amplication, you are in control. While Amplication will not automatically generate code in the ignored folders and files, you can still see what the generated code _could_ look like. This way, you can cherry pick whatever Amplication-generated changes you like and use them in your code. You can find these files in `.amplication/ignored` in the git repository. 33 | ::: 34 | -------------------------------------------------------------------------------- /docs/custom-code/assets/add-custom-dto/customer-type-filter-error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/custom-code/assets/add-custom-dto/customer-type-filter-error.png -------------------------------------------------------------------------------- /docs/custom-code/assets/add-custom-dto/customer-type-filter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/custom-code/assets/add-custom-dto/customer-type-filter.png -------------------------------------------------------------------------------- /docs/custom-code/assets/add-custom-dto/customer-type-option-set.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/custom-code/assets/add-custom-dto/customer-type-option-set.png -------------------------------------------------------------------------------- /docs/custom-code/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Customize Your Application 3 | --- 4 | 5 | # Customize Your Application 6 | 7 | Amplication enables you to generate code, manage custom files, and seed databases. We'll give you a brief overview of what Amplication can do in this area. 8 | 9 | ## Custom Code with Amplication 10 | 11 | Amplication generates application code that can be customized to fit your specific needs. It provides several examples and guides on how to achieve this, including: 12 | 13 | - [Add action to REST API Controller](/custom-code/controller-action/) 14 | - [Add a custom DTO](/custom-code/custom-dto/) 15 | - [Adding a query to a GraphQL resolver](/custom-code/graphql-query/) 16 | 17 | These guides cover various aspects of customizing your application code, from adding new fields and relationships to creating custom resolvers and enforcing access control. 18 | 19 | ## Managing Custom Files 20 | 21 | Amplication ensures that your custom files are not affected when it regenerates code. To provide even greater control, it includes the `.amplicationignore` file, which allows you to specify files that should be ignored during the code generation process. 22 | 23 | For more information on how to manage custom files and use the `.amplicationignore` file, visit the [Managing custom files](/custom-code/managing-custom-files/) guide. 24 | 25 | ## Seeding a Database 26 | 27 | Database seeding is the process of populating a database with initial data. Amplication enables you to use a custom script to seed your database on initialization. This can be useful for providing your application with required data or adding dummy data for testing and development purposes. 28 | 29 | To learn more about seeding a database with Amplication, refer to the [Seeding a database guide](/custom-code/seed-db/). 30 | -------------------------------------------------------------------------------- /docs/custom-code/seed-a-db.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: seed-db 3 | title: Seeding a database 4 | sidebar_label: Seeding a database 5 | slug: /custom-code/seed-db 6 | --- 7 | 8 | # Seeding a database 9 | 10 | Database seeding is the initial seeding of a database with data. 11 | 12 | You can use a custom script to populate the database on initialization. 13 | 14 | This can be useful for populating your database with necessary data that is required for your application to start, or it can be dummy data for validating and using your application in a development environment. 15 | 16 | Seeding the database is done using the `customSeed.ts` file. 17 | 18 | :::info 19 | For more information about seeding, see [Prisma docs](https://www.prisma.io/docs/guides/database/seed-database) 20 | ::: 21 | 22 | 23 | 24 | ```typescript 25 | const client = new PrismaClient(); 26 | const data = { 27 | username: "admin", 28 | password: await hash("admin", bcryptSalt), 29 | roles: ["user"], 30 | }; 31 | 32 | //replace this sample code to populate your databases 33 | //with data that is required for your application to start 34 | 35 | await client.user.upsert({ 36 | where: { username: data.username }, 37 | update: {}, 38 | create: data, 39 | }); 40 | void client.$disconnect(); 41 | } 42 | ``` 43 | -------------------------------------------------------------------------------- /docs/dictionary/en-custom.txt: -------------------------------------------------------------------------------- 1 | ampconfig 2 | amplication 3 | amplicationrc 4 | Amplication 5 | amplication's 6 | Amplication's 7 | Amplication’s 8 | api 9 | APIs 10 | authservice 11 | automations 12 | Axios 13 | bitnami 14 | Blockquotes 15 | Cantarell 16 | clsx 17 | Consolas 18 | customizability 19 | createmessagebrokernestjsmodule 20 | Docker's 21 | dockerized 22 | Docusaurus 23 | dto 24 | DTOs 25 | Fira 26 | Formik 27 | gh 28 | GraphQL 29 | grayscale 30 | guide 31 | guides 32 | Helvetica 33 | httpclientmodule 34 | incompleted 35 | init 36 | installable 37 | js 38 | kubectl 39 | Kubernetes 40 | libauthjs 41 | libtasksjs 42 | Menlo 43 | Minikube 44 | monospace 45 | NestJS 46 | Neue 47 | npm 48 | oclif 49 | OpenAPI 50 | ORM 51 | perf 52 | postgres 53 | postgresql 54 | Posthog 55 | polyrepo 56 | Prisma 57 | promisable 58 | React's 59 | ReactJS 60 | Roadmap 61 | Roboto 62 | scalable 63 | Segoe 64 | signup 65 | Strikethrough 66 | subfolder 67 | subfolders 68 | tasksservice 69 | todos 70 | Todos 71 | transpilation 72 | TypeScript 73 | UI 74 | upsert 75 | upvote 76 | webp 77 | Wontfix 78 | microservices 79 | amplicationignore 80 | dbsettings 81 | drawio 82 | heirarchy 83 | autoplay 84 | youtube 85 | OpenTelemetry 86 | RDBMS 87 | NATS 88 | datasource 89 | autoincrement 90 | Baselining 91 | configmap 92 | kubeconfig 93 | DALLE 94 | frontends 95 | Zustand 96 | Supertokens 97 | Bitwarden 98 | Jovu 99 | Jovu's 100 | passwordless 101 | Appsettings 102 | appsettings 103 | Codespaces 104 | Keycloak 105 | thirdparty 106 | emailpassword 107 | placeholder 108 | Quickstart 109 | autoupdating -------------------------------------------------------------------------------- /docs/errors/Installation-is-slow.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: installation-slow 3 | title: Installation is slow 4 | tags: 5 | - node.js 6 | - npm 7 | - Typescript 8 | - Setup 9 | sidebar_label: Installation is slow 10 | slug: /errors/installation-slow 11 | --- 12 | 13 | # Installation is slow 14 | 15 | ## Overview 16 | 17 | Installation npm with the following command often takes a long time to complete 18 | `npm run setup:dev` 19 | 20 | ## Symptoms 21 | 22 | When running `npm run setup:dev` the installation may take much longer than expected to complete. 23 | This may cause the user to assume the process is stuck, and so abort the process. 24 | 25 | ## Cause 26 | 27 | `npm run setup:dev` runs multiple processes so it will often takes longer than expected. This may cause the user to assume that the process has stopped responding. 28 | 29 | ## Resolution 30 | 31 | - Wait patiently until the process is completed. 32 | 33 | - If you stopped the process in the middle, delete node modules and re-install npm as follows: 34 | 35 | ```bash 36 | npm run clean 37 | npm install 38 | npm run setup:dev; 39 | ``` 40 | 41 | :::note 42 | Stopping the installation process can result in changes to the package.json. We recommend checking that Lerna did not change the file, and if it did, to discard the changes. 43 | ::: 44 | 45 | - Ask for help on our [Discord Server](https://amplication.com/discord) 46 | 47 | ## Related Issue 48 | 49 | [Installation fails](./installation-fails.md) 50 | 51 | ## Additional Information 52 | 53 | N/A 54 | 55 | ## Related Discord Thread 56 | 57 | Discord Thread: [npm run setup:dev takes a long time to complete](https://discordapp.com/channels/757179260417867879/968914282978893874) 58 | -------------------------------------------------------------------------------- /docs/errors/assets/prism-postgresql-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/errors/assets/prism-postgresql-access.png -------------------------------------------------------------------------------- /docs/errors/could-not-authorize-user.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: could-not-authorize-user 3 | title: Could not authorize user 4 | sidebar_label: Could not authorize user 5 | slug: /errors/could-not-authorize-user 6 | --- 7 | 8 | # Could not authorize user 9 | 10 | ## Message 11 | 12 | CLI Error: Could not authorize user 13 | 14 | ## What went wrong? 15 | 16 | Amplication CLI could not authenticate with Amplication Server. 17 | 18 | This error may happen if you are working with the wrong Amplication server. 19 | 20 | 21 | ## What to do? 22 | 23 | Run the command ```amp config``` to see the URL of the Amplication server used by the CLI. 24 | 25 | The results should look like the below 26 | 27 | ``` 28 | AMP_CURRENT_APP=undefined 29 | AMP_CURRENT_ENTITY=undefined 30 | AMP_CURRENT_FIELD=undefined 31 | AMP_SERVER_URL=http://localhost:3000/ 32 | AMP_OUTPUT_FORMAT=undefined 33 | ``` 34 | Use this command to set the correct URL for the Amplication server 35 | 36 | ```$ amp config:set AMP_SERVER_URL https://server.amplication.com``` 37 | -------------------------------------------------------------------------------- /docs/errors/prisma-denied-access-on-postgres.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: prisma-denied-access-on-postgres 3 | title: Prisma is denied access to the PostgreSQL db 4 | tags: 5 | - Prisma 6 | - PostgreSQL 7 | - db 8 | 9 | sidebar_label: Prisma is denied access to the PostgreSQL db 10 | slug: /errors/prisma-denied-access-on-postgres 11 | --- 12 | 13 | ## Overview 14 | `npm run setup:dev` failed on step 6 with the following message: 15 | 16 | ![](./assets/prism-postgresql-access.png) 17 | 18 | 19 | ## Symptoms 20 | Access to the db was denied while trying to start the db. 21 | Docker is running. 22 | 23 | ## Cause 24 | 25 | This error and similar errors (related to accessing db) is usually caused by another PostgreSQL process that runs on the same port (5432). 26 | 27 | ## Resolution 28 | 29 | Stop the other process that runs on port 5432 or change the port on the Amplication generated app. 30 | 31 | ## Related Issue 32 | 33 | N/A 34 | 35 | ## Additional Information 36 | 37 | N/A 38 | 39 | -------------------------------------------------------------------------------- /docs/getting-started-v2/example-services.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: Example Services 3 | --- -------------------------------------------------------------------------------- /docs/getting-started-v2/intro-to-amplication.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: Intro to Amplication 3 | --- -------------------------------------------------------------------------------- /docs/getting-started-v2/quickstart.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: Quickstart 3 | --- -------------------------------------------------------------------------------- /docs/getting-started/Field-settings-dropdownlist.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/Field-settings-dropdownlist.png -------------------------------------------------------------------------------- /docs/getting-started/Field-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/Field-settings.png -------------------------------------------------------------------------------- /docs/getting-started/assets/all-addons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/all-addons.png -------------------------------------------------------------------------------- /docs/getting-started/assets/all-plugins-and-categories.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/all-plugins-and-categories.png -------------------------------------------------------------------------------- /docs/getting-started/assets/all-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/all-plugins.png -------------------------------------------------------------------------------- /docs/getting-started/assets/amplicationrc-json-plugin-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/amplicationrc-json-plugin-settings.png -------------------------------------------------------------------------------- /docs/getting-started/assets/app-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/app-settings.png -------------------------------------------------------------------------------- /docs/getting-started/assets/authentication/auth-rest.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/authentication/auth-rest.png -------------------------------------------------------------------------------- /docs/getting-started/assets/authentication/delete_user_popup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/authentication/delete_user_popup.png -------------------------------------------------------------------------------- /docs/getting-started/assets/authentication/disable_auth_plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/authentication/disable_auth_plugin.png -------------------------------------------------------------------------------- /docs/getting-started/assets/authentication/new_user_entity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/authentication/new_user_entity.png -------------------------------------------------------------------------------- /docs/getting-started/assets/authentication/plugin_installation_cannot_proceed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/authentication/plugin_installation_cannot_proceed.png -------------------------------------------------------------------------------- /docs/getting-started/assets/building-new-versions/compare-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/building-new-versions/compare-changes.png -------------------------------------------------------------------------------- /docs/getting-started/assets/building-new-versions/new-build.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/building-new-versions/new-build.png -------------------------------------------------------------------------------- /docs/getting-started/assets/building-new-versions/project-owner-due-date.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/building-new-versions/project-owner-due-date.png -------------------------------------------------------------------------------- /docs/getting-started/assets/client-secret.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/client-secret.png -------------------------------------------------------------------------------- /docs/getting-started/assets/deploy/connect-to-git-provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/deploy/connect-to-git-provider.png -------------------------------------------------------------------------------- /docs/getting-started/assets/deploy/generated-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/deploy/generated-app.png -------------------------------------------------------------------------------- /docs/getting-started/assets/deploy/login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/deploy/login.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/commit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/commit.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/created-entity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/created-entity.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/entities.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/entities.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/granular-fields-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/granular-fields-2.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/granular-fields.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/granular-fields.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/granular-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/granular-permissions.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/name-field.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/name-field.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/overview-window.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/overview-window.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/pending-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/pending-changes.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/permissions.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/roles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/roles.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-app/task.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-app/task.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/admin-ui-graph-rest-api.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/admin-ui-graph-rest-api.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/amplication-home-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/amplication-home-page.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/authentication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/authentication.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/data-model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/data-model.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/database.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/generating-service.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/generating-service.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/install-amplication-github-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/install-amplication-github-app.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/monorepo-polyrepo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/monorepo-polyrepo.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/select-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/select-repository.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/service-created-successfully.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/service-created-successfully.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/service-name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/service-name.png -------------------------------------------------------------------------------- /docs/getting-started/assets/first-service/sync-with-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/first-service/sync-with-github.png -------------------------------------------------------------------------------- /docs/getting-started/assets/generated-app-api/graphql-playground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/generated-app-api/graphql-playground.png -------------------------------------------------------------------------------- /docs/getting-started/assets/generated-app-api/swagger-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/generated-app-api/swagger-ui.png -------------------------------------------------------------------------------- /docs/getting-started/assets/generated-app/admin-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/generated-app/admin-ui.png -------------------------------------------------------------------------------- /docs/getting-started/assets/generated-app/app-components.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/generated-app/app-components.png -------------------------------------------------------------------------------- /docs/getting-started/assets/generated-app/app-components2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/generated-app/app-components2.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/granular-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/granular-1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/granular.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/granular.png -------------------------------------------------------------------------------- /docs/getting-started/assets/import-prisma-schema-log.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/import-prisma-schema-log.png -------------------------------------------------------------------------------- /docs/getting-started/assets/install-a-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/install-a-plugin.png -------------------------------------------------------------------------------- /docs/getting-started/assets/installed-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/installed-plugins.png -------------------------------------------------------------------------------- /docs/getting-started/assets/new-database-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/new-database-plugin.png -------------------------------------------------------------------------------- /docs/getting-started/assets/overview-window.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/overview-window.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-1.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-2.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-2.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-3.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-3.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-4.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-4.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-5.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-5.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-8.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-8.1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-8.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-9.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-9.1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic-9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic-9.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic0.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic11.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic11.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic11.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic13.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic13.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/pic13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic13.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic8.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic8.1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/pic8.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/pic8.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/plugin-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/plugin-settings.png -------------------------------------------------------------------------------- /docs/getting-started/assets/plugin-versions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/plugin-versions.png -------------------------------------------------------------------------------- /docs/getting-started/assets/prettier-plugin-settings-filled-in.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/prettier-plugin-settings-filled-in.png -------------------------------------------------------------------------------- /docs/getting-started/assets/project-structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/project-structure.png -------------------------------------------------------------------------------- /docs/getting-started/assets/public-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/public-1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/public1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/public1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/relations/related-entity--1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/relations/related-entity--1.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/relations/related-entity--2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/relations/related-entity--2.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/relations/relation-cardinality.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/relations/relation-cardinality.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/relations/self-relation-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/relations/self-relation-1.jpg -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/entities-from-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/entities-from-overview.png -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/generated-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/generated-code.png -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/github-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/github-pull-request.png -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/name-relations-field-from-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/name-relations-field-from-user.png -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/service-entities-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/service-entities-permissions.png -------------------------------------------------------------------------------- /docs/getting-started/assets/service-entities-roles-permissions/specific-permissions-fields.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/service-entities-roles-permissions/specific-permissions-fields.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/1bb1238f-01a7-4650-aeb2-6f5ae8ae76c7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/1bb1238f-01a7-4650-aeb2-6f5ae8ae76c7.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/32086706-520a-4996-8647-ecd81546f4f5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/32086706-520a-4996-8647-ecd81546f4f5.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/495c5ae4-edae-4a8f-8338-09eaadc27998.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/495c5ae4-edae-4a8f-8338-09eaadc27998.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/4b389970-6207-4010-b181-405806ff87c8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/4b389970-6207-4010-b181-405806ff87c8.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/4d38da6f-9b1c-4844-91ec-ec9b101c4503.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/4d38da6f-9b1c-4844-91ec-ec9b101c4503.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/930b3e58-62e3-4b14-950c-13e11a41c878.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/930b3e58-62e3-4b14-950c-13e11a41c878.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/945389.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/945389.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/Select-repository-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/Select-repository-2.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/amplication-bitbucket-consumer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/amplication-bitbucket-consumer.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/amplication-commit-message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/amplication-commit-message.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/bitbucket-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/bitbucket-pull-request.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/build-log-message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/build-log-message.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/commit-changes-and-build.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/commit-changes-and-build.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/commits-dropdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/commits-dropdown.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/commits-history.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/commits-history.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/commits.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/dac2b208-365c-4bf4-9a49-f0914648cf8f.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/dac2b208-365c-4bf4-9a49-f0914648cf8f.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/github-account-configuration-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/github-account-configuration-settings.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/github-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/github-code.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/github-pull-request-amplication-branch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/github-pull-request-amplication-branch.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/github-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/github-pull-request.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/install_amplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/install_amplication.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/open-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/open-github.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/push-to-bitbucket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/push-to-bitbucket.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/resource-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/resource-overview.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/select-git-provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/select-git-provider.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/select-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/select-repository.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/select-workspace.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/select-workspace.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/sync-with-git-provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/sync-with-git-provider.png -------------------------------------------------------------------------------- /docs/getting-started/assets/sync-with-git-provider/sync-with-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/sync-with-git-provider/sync-with-github.png -------------------------------------------------------------------------------- /docs/getting-started/assets/uninstall-auth-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/uninstall-auth-plugins.png -------------------------------------------------------------------------------- /docs/getting-started/assets/unistall-auth-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/unistall-auth-plugins.png -------------------------------------------------------------------------------- /docs/getting-started/assets/view-code2a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/view-code2a.png -------------------------------------------------------------------------------- /docs/getting-started/assets/view-code3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/view-code3.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace1.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace2.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace3.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace4.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace5.png -------------------------------------------------------------------------------- /docs/getting-started/assets/workspace6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/getting-started/assets/workspace6.png -------------------------------------------------------------------------------- /docs/getting-started/beta-version.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: beta-version 3 | title: Amplication Beta Version 4 | sidebar_label: Beta Version 5 | slug: /beta-version 6 | --- 7 | 8 | # Amplication Beta Version 9 | 10 | Amplication is currently in Beta. It means that we are still working on essential features like production-ready hosting, migrations, and stability to our console. 11 | 12 | 13 | How does it effect you? Well...., it mostly doesn't. 14 | 15 | Every app generated using Amplication platform is built on top of well-adopted, open-source packages, that are all production-ready. These packages are independently documented, supported, and maintained by their own teams on regular basis. ([read more about our stack here](/getting-started#technologies)). Your app is stable, scalable, and production-ready you can deploy and rely on. 16 | ## Amplication Sandbox Environment 17 | Please note, Our free sandbox environment is limited in resources, not backed up, and can reset at any time therefore we do not recommend using the free sandbox environment as a production environment. 18 | -------------------------------------------------------------------------------- /docs/getting-started/deploy-docker-desktop.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: deploy-docker-desktop 3 | title: Deploy to Docker Desktop 4 | description: Learn how to deploy your Amplication service to Docker. 5 | sidebar_label: Deploy to Docker Desktop 6 | slug: /deploy/docker-desktop 7 | --- 8 | 9 | To deploy to Docker, build a Docker image and run a Docker container. 10 | 11 | Your project is always generated with all the configuration and scripts needed to build a Docker container to prepare your app for deployment. 12 | 13 | First clone source code from your repository. See [Sync with GitHub](https://docs.amplication.com/sync-with-github/) for more information about working with source code. 14 | 15 | To run your app in Docker with a functional database, execute the docker-compose command: 16 | 17 | `docker-compose up` 18 | 19 | --- 20 | 21 | TIP: 22 | If you store your services in a monorepo git repository, run `docker-compose up` from within the service folder you want to run. 23 | 24 | --- 25 | -------------------------------------------------------------------------------- /docs/getting-started/phone-home.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: phone-home 3 | title: Phone Home - Collecting Usage Data 4 | sidebar_label: Phone Home - Collecting Usage Data 5 | slug: /about/phone-home 6 | --- 7 | 8 | # Phone Home - Collecting Usage Data 9 | 10 | Amplication’s open-source server includes Phone Home, a call-back operation where every deployed server contacts a central server to indicate to the Amplication core team that it is up and running. 11 | 12 | This works by adding a notification event to the server load, sending a loading notification message to [Posthog](https://posthog.com/), a monitoring/analytics tool that enables the Amplication core team to see the number of deployments. 13 | 14 | The purpose of this information gathering is to get a better understanding of how new features are impacting the use and adoption of Amplication. 15 | 16 | ## Information Gathered 17 | 18 | The following information is gathered for each deployment: 19 | 20 | - Build version 21 | - Server version 22 | - Runtime environments (OS, node version, etc.) 23 | 24 | :::note 25 | No personal or private information is collected. The statistics are anonymous, and users are not identified. 26 | ::: 27 | 28 | ## Disabling Phone Home 29 | 30 | If you don’t want Amplication to add your deployment to its usage statistics, you can disable the feature as follows: 31 | 32 | Set `DISABLE_EVENT_TRACKING` to 1. 33 | 34 | Where `DISABLE_EVENT_TRACKING` is an environment variable. 35 | -------------------------------------------------------------------------------- /docs/getting-started/projects.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: projects-resources-services 3 | title: Understanding Projects, Resources and Services 4 | sidebar_label: Understanding Project, Resources, and Services 5 | slug: /projects-resources-services 6 | --- 7 | # Understanding Projects, Resources, and Services 8 | 9 | Amplication supports for microservices through the introduction of a Project hierarchy. 10 | 11 | This article describes **Projects**, **Resources**, and **Services** - key concepts that drive Amplication’s workflow. 12 | 13 | :::tip 14 | Parts of the documentation still reflect the previous app-based workflow. We are working to update this. 15 | ::: 16 | 17 | 18 | ## Project 19 | A Project is a hierarchy that groups together multiple Resources that form the building blocks of the development process. 20 | 21 | 22 | ![](./assets/project-structure.png) 23 | 24 | ## Resource 25 | A Resource is any element that goes into creating a project with Amplication, such as Project Configuration and Service. 26 | Additional types of Resources to be added in upcoming releases include storage, API gateways, and more. 27 | 28 | 29 | 30 | ## Service 31 | 32 | In earlier releases of Amplication, Services were known as apps, and the workflow supported the creation of individual and separate apps. Now, with the Project as the framework for the development process, each Project can contain multiple connected Services, enabling support for multiple use cases. 33 | 34 | See [Create Your First Service](/first-service/) for more information. 35 | -------------------------------------------------------------------------------- /docs/getting-started/view-generated-code.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: view-generated-code 3 | title: Viewing the generated code 4 | sidebar_label: View the generated code 5 | slug: /getting-started/view-generated-code 6 | --- 7 | 8 | # Viewing the Generated Code 9 | 10 | Use **Code View** to view and explore the generated code. You can see the updated code before it is synced with GitHub or downloaded. 11 | 12 | :::note 13 | 14 | - Graphic files are not visible with _Code View_. 15 | - You cannot edit files with _Code View_. 16 | 17 | ::: 18 | 19 | On the _Overview_ page, click **View Code**, or click the **Code View** icon on the menu. 20 | 21 | Then, select a build from the **Select build** list. 22 | 23 | ![](../getting-started/assets/view-code2a.png) 24 | 25 | :::note 26 | 27 | - The default build is the last one you created. 28 | - You can create a new build even if you have not made any changes. 29 | - _Code View_ does not support builds created in earlier Amplication versions, before the feature had been introduced. 30 | 31 | ::: 32 | 33 | If you navigate to the required file. The code is displayed. 34 | 35 | ![](../getting-started/assets/view-code3.png) 36 | -------------------------------------------------------------------------------- /docs/how-to/add-custom-commits.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/add-custom-commits.md -------------------------------------------------------------------------------- /docs/how-to/api-adminui-settings.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: api-admin-ui-settings 3 | title: How to configure selective code generation 4 | sidebar_label: Configure selective code generation 5 | slug: /how-to/api-admin-ui-settings 6 | --- 7 | 8 | # Configure Selective Code Generation 9 | 10 | Amplication enables you to include or exclude the following components from the generated code. 11 | 12 | - GraphQL API 13 | - REST API 14 | - Admin UI 15 | 16 | 17 | 18 | 19 | ## Selecting which components to generate 20 | 21 | 22 | 23 | 1. In **App settings**, select **APIs & Admin UI**. 24 | 25 | ![](./assets/api-admin-ui-settings.png) 26 | 27 | 2. Click the toggle switch to activate or deactivate the following: 28 | - **GraphQL API** 29 | - **REST API & Swagger UI** 30 | - **Admin UI** 31 | 32 | :::tip 33 | **Admin UI** can be selected only if **GraphQL API** has been selected. 34 | ::: 35 | -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/build-and-commit-project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/build-and-commit-project.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-actions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-actions.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-blog-service.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-blog-service.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-entities.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-entities.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-entity-fields.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-entity-fields.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-new-dto.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-new-dto.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-new-module.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-new-module.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/create-new-project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/create-new-project.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/implement-user-authentication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/implement-user-authentication.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/install-multiple-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/install-multiple-plugins.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/new-service.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/new-service.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/recommendations-for-plugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/recommendations-for-plugins.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-ai/update-git-provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-ai/update-git-provider.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-analytics-dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-analytics-dashboard.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-erd-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-erd-view.png -------------------------------------------------------------------------------- /docs/how-to/assets/amplication-platform-console.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/amplication-platform-console.png -------------------------------------------------------------------------------- /docs/how-to/assets/api-admin-ui-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/api-admin-ui-settings.png -------------------------------------------------------------------------------- /docs/how-to/assets/authentication-entity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/authentication-entity.png -------------------------------------------------------------------------------- /docs/how-to/assets/base-directories.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/base-directories.png -------------------------------------------------------------------------------- /docs/how-to/assets/code-generator-version-control.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/code-generator-version-control.png -------------------------------------------------------------------------------- /docs/how-to/assets/create-service-from-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/create-service-from-template.png -------------------------------------------------------------------------------- /docs/how-to/assets/custom-actions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/custom-actions.png -------------------------------------------------------------------------------- /docs/how-to/assets/data-types.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/data-types.png -------------------------------------------------------------------------------- /docs/how-to/assets/default-custom-attribute.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/default-custom-attribute.png -------------------------------------------------------------------------------- /docs/how-to/assets/download-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/download-code.png -------------------------------------------------------------------------------- /docs/how-to/assets/entity-field-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/entity-field-settings.png -------------------------------------------------------------------------------- /docs/how-to/assets/field-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/field-settings.png -------------------------------------------------------------------------------- /docs/how-to/assets/foreign-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/foreign-key.png -------------------------------------------------------------------------------- /docs/how-to/assets/github-app-settings-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/github-app-settings-page.png -------------------------------------------------------------------------------- /docs/how-to/assets/install-amplication-github-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/install-amplication-github-app.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/apis.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/apis.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/complete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/complete.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/database.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/name-and-stack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/name-and-stack.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/platform-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/platform-changes.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/publish.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/publish.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/service-template-dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/service-template-dashboard.png -------------------------------------------------------------------------------- /docs/how-to/assets/live-service-templates/settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/live-service-templates/settings.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-1.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-2.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-3.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-4.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-5.png -------------------------------------------------------------------------------- /docs/how-to/assets/message-broker-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/message-broker-6.png -------------------------------------------------------------------------------- /docs/how-to/assets/npm-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/npm-install.png -------------------------------------------------------------------------------- /docs/how-to/assets/npm-server-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/npm-server-install.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-4.jpg -------------------------------------------------------------------------------- /docs/how-to/assets/pic-5.2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-5.2.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-5.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-5.jpg -------------------------------------------------------------------------------- /docs/how-to/assets/pic-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-6.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-7.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-7a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-7a.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-8.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic-9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic-9.png -------------------------------------------------------------------------------- /docs/how-to/assets/pic8.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/pic8.jpg -------------------------------------------------------------------------------- /docs/how-to/assets/platform-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/platform-changes.png -------------------------------------------------------------------------------- /docs/how-to/assets/project-dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/project-dashboard.png -------------------------------------------------------------------------------- /docs/how-to/assets/public1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/public1.png -------------------------------------------------------------------------------- /docs/how-to/assets/relation-entity.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/relation-entity.PNG -------------------------------------------------------------------------------- /docs/how-to/assets/select-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/select-repository.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/above-grid-add-filter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/above-grid-add-filter.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/card-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/card-view.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/code-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/code-view.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/commits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/commits.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/filter-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/filter-view.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/grid-view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/grid-view.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/pending-changes-sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/pending-changes-sidebar.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/pending-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/pending-changes.png -------------------------------------------------------------------------------- /docs/how-to/assets/service-catalog/service-catalog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/service-catalog/service-catalog.png -------------------------------------------------------------------------------- /docs/how-to/assets/sso-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/sso-login.png -------------------------------------------------------------------------------- /docs/how-to/assets/template-name-and-stack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/template-name-and-stack.png -------------------------------------------------------------------------------- /docs/how-to/assets/upload-prisma-schema-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/upload-prisma-schema-button.png -------------------------------------------------------------------------------- /docs/how-to/assets/upload-prisma-schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/upload-prisma-schema.png -------------------------------------------------------------------------------- /docs/how-to/assets/view-code1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/view-code1.png -------------------------------------------------------------------------------- /docs/how-to/assets/view-code2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/view-code2.png -------------------------------------------------------------------------------- /docs/how-to/assets/view-code2a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/view-code2a.png -------------------------------------------------------------------------------- /docs/how-to/assets/view-code3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/how-to/assets/view-code3.png -------------------------------------------------------------------------------- /docs/how-to/change-base-branch.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: change-base-branch-for-pull-requests 3 | title: How To Change Base Branch For Pull Requests 4 | sidebar_label: How To Change Base Branch For Pull Requests 5 | slug: /how-to/change-base-branch-for-pull-requests 6 | --- 7 | 8 | # How To Change Base Branch For Pull Requests 9 | 10 | By default, Amplication will create pull requests from the `amplication` branch into your repository's base branch. 11 | This is usually `main` or `master` for many repositories. 12 | 13 | It's possible to change the base branch that Amplication uses for pull requests. 14 | This allows you to merge changes into a different branch. 15 | 16 | For example, you may want pull requests to merge into a development branch first before your main branch. 17 | 18 | :::info 19 | This feature requires an Enterprise plan. 20 | Review plan differences on the [Git Sync Plan Differences](sync-with-git-differences-between-plans) page. 21 | ::: 22 | 23 | ## Change the base branch for _all_ services in your project 24 | 25 | 1. Go to your _project's_ Git Settings page. 26 | 2. You'll see a new **Base Branch** text field. 27 | 3. Enter the name of the branch you want Amplication to merge changes into. 28 | 4. Your new base branch is saved when you click out of the text field. 29 | 30 | ## Change the base branch for a _specific_ service in your project 31 | 32 | 1. Visit your _service's_ Git Settings page. 33 | 2. Click on the `Override default settings` toggle. 34 | 3. [Re-select](#select-your-repository) your GitHub repository. 35 | 4. You'll see a new **Base Branch** text field. 36 | 5. Enter the name of the branch you want Amplication to merge changes into. 37 | 6. Your new base branch is saved when you click out of the text field. 38 | 39 | Amplication will now send pull requests into the new base branch you specified. 40 | -------------------------------------------------------------------------------- /docs/how-to/commit-changes.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: how-to-commit-changes 3 | title: How To Commit Changes 4 | sidebar_label: How To Commit Changes 5 | slug: /how-to/commit-changes 6 | --- 7 | 8 | # How To Commit Changes 9 | 10 | While working in Amplication your changes are saved automatically, but are not committed. Only committed changes will be included in the next version of your application. 11 | 12 | In the _Pending Changes_ control in the main menu (left sidebar) you can see how many pending changes are waiting to be committed. 13 | 14 | ![](../getting-started/assets/pic8.jpg) 15 | 16 | 1. In the _commit message_ dialog, write a description of the changes you're committing. 17 | 2. Click **Commit Changes**. All changes are committed. A new build of your app is automatically created! 18 | -------------------------------------------------------------------------------- /docs/how-to/create-entity.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: how-to-create-entity 3 | title: How To Create An Entity 4 | sidebar_label: How To Create An Entity 5 | description: Learn how to create an Amplication entity. 6 | slug: /how-to/create-entity 7 | --- 8 | 9 | # How To Create An Entity 10 | 11 | :::tip 12 | When creating an entity, make sure you do not use a reserved name for the name of the entity or for any of its fields. Go [here](https://github.com/amplication/amplication/blob/master/packages/amplication-server/src/core/entity/reservedNames.ts) to check the list of reserved names. 13 | ::: 14 | 15 | Click the **Entities** icon on the left sidebar (main menu) to reach the Entities page. Here you see all the entities in your application. 16 | 17 | ![](../getting-started/assets/pic-1.jpg) 18 | 19 | 1. Click **Create New**. 20 | 2. In the _New Entity_ dialog, type in the name of the new Entity. 21 | 3. Click **Create Entity**. 22 | 23 | :::tip 24 | White spaces are supported, which is useful when you want to enter a descriptive entity name. The value is saved as the entity’s display name. In addition to the display name, each entity has an auto-generated Name that does not contain spaces or special characters. This name is later used for the API endpoint and in other places in the generated code. If needed, you can manually change the entity name in the entity's page. 25 | ::: 26 | 27 | ![](../getting-started/assets/pic-2.jpg) 28 | 29 | :::info 30 | Notice that the added entity comes with auto-generated values like **Plural Display Name** and some default fields – ID, Created At, and Updated At. 31 | ::: 32 | -------------------------------------------------------------------------------- /docs/how-to/default-value-entity-field.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: How To Set Default Value for an Entity Field 3 | sidebar_label: Set Default Value for an Entity Field 4 | slug: /how-to/set-default-value-entity-field 5 | --- 6 | 7 | # How To Set Default Value for an Entity Field 8 | 9 | Setting default values for your entity fields in Amplication is straightforward using the `@default()` custom Prisma attribute. 10 | This can be helpful in scenarios where you want certain fields to have a predefined value when new records are created. 11 | 12 | This guide will walk you through the steps to achieve this with various examples. 13 | 14 | ![Default Custom Prisma Attribute](./assets/default-custom-attribute.png) 15 | 16 | ## Steps to Set a Default Value: 17 | 18 | 1. Navigate to your service's _Entity Overview_ page. 19 | 2. Click on the specific _Entity_ field you want to set a default value for. 20 | 3. On the Entity Field page, you will find a text box labeled **Custom Attributes**. Here, you'll enter the custom prisma `@default()` attribute. 21 | 4. In the Custom Attribute text field, enter the `@default()` attribute followed by the desired default value in parentheses. 22 | 5. After entering the default value, it will be saved automatically. 23 | 24 | ## Examples 25 | 26 | For example, to set a default string value of "DefaultText", you would enter: 27 | 28 | ``` 29 | @default("DefaultText") 30 | ``` 31 | 32 | For numeric fields, simply enter the number without quotes: 33 | 34 | ``` 35 | @default(5) 36 | ``` 37 | 38 | :::tip 39 | Refer to [Prisma's documentation](https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference#default) for a full list of the values that Prisma gives you access to for the `@default()` custom attribute. 40 | ::: -------------------------------------------------------------------------------- /docs/how-to/enterprise-sso.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: enterprise-sso 3 | title: Enterprise SSO 4 | sidebar_label: SSO 5 | slug: /enterprise-sso 6 | pagination_prev: how-to/change-base-branch-for-pull-requests 7 | pagination_next: getting-started/sync-with-git-differences-between-plans 8 | --- 9 | 10 | Amplication provides Single Sign-On (SSO) support for Enterprise plan users. 11 | This makes it easier for your organization's members to access their Amplication accounts using your existing SSO provider. 12 | 13 | :::note 14 | SSO is only **available for Enterprise Plan users**. 15 | Try it during your 7-day Enterprise plan trial for new workspaces. 16 | ::: 17 | 18 | ## Enabling SSO 19 | 20 | 1. [Contact our team](https://amplication.com/contact-us/) to help you set up SSO. 21 | 2. Our team will handle the setup and integration with your organization's SSO provider. 22 | 23 | ## Logging In via SSO 24 | 25 | 1. Visit [Amplication's login page](https://app.amplication.com/login). 26 | 2. Click on the **Continue with SSO** link. 27 | 3. Enter the email address associated with your Amplication account. 28 | 4. Click **Continue**. 29 | 5. You are now successfully logged in. 30 | 31 | ![](./assets/sso-login.png) 32 | -------------------------------------------------------------------------------- /docs/how-to/erd-view-for-amplication-entities.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: erd-view-for-amplication-entities 3 | title: ERD View for Amplication Entities 4 | sidebar_label: ERD View for Amplication Entities Explained 5 | slug: /erd-view-for-entities 6 | --- 7 | 8 | # ERD View for Amplication Entities 9 | 10 | Amplication's ERD (Entity Relationship Diagram) view provides a complete graphical representation of how your entities relate to each other. 11 | 12 | ![Amplication's Entity ERD View](./assets/amplication-erd-view.png) 13 | 14 | ## How to activate ERD View 15 | 16 | 1. Navigate to the Entities page of your Amplication service. 17 | 2. In the center, to the right of the search bar, you'll find a toggle switch. 18 | 3. Toggle the switch to enable the ERD view. Slide it back to return to the traditional list view. 19 | 20 | ## Available Features 21 | 22 | - **Zoom**: Zoom in and out using the pinch mechanism to get a clearer view of your entities. 23 | - **Drag and Drop**: Make the relationships between your entities clearer by using the drag and drop functionality. 24 | 25 | ## Next Steps 26 | 27 | 1. The [Entity Relations](/relations) page explains how to define relationships between entities. 28 | 2. The [Create a new entity field](/how-to/create-entity-field) page covers all the options for creating fields on entities. 29 | -------------------------------------------------------------------------------- /docs/how-to/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: How Tos 3 | --- 4 | 5 | # How Tos 6 | 7 | The How Tos section teaches you how to accomplish various tasks and operations within Amplication. Each section briefly describes a topic and includes a link to a more detailed tutorial. 8 | 9 | Whether you are a beginner just starting with Amplication or an experienced developer looking to extend your application's functionality, these tutorials will serve as valuable resources to help you unlock the full potential of the platform. 10 | 11 | ## Available How Tos 12 | 13 | - [Create a new Service](/how-to/create-service/) 14 | - [Create an Entity](/how-to/create-entity/) 15 | - [Create a new entity field](/how-to/create-entity-field) 16 | - [Set Access Permissions](/how-to/set-access-permissions/) 17 | - [Commit Changes](/how-to/commit-changes) 18 | - [Entity Relations](/relations/) 19 | - [Base Directories](/how-to/base-directories) 20 | - [Configure selective code generation](/how-to/api-admin-ui-settings/) 21 | - [Create a message broker](/guides/message-broker) 22 | 23 | Browse through the available tutorials and start building your web app with Amplication. 24 | -------------------------------------------------------------------------------- /docs/platform-features/assets/alert-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/alert-properties.png -------------------------------------------------------------------------------- /docs/platform-features/assets/alert-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/alert-settings.png -------------------------------------------------------------------------------- /docs/platform-features/assets/alert-types.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/alert-types.png -------------------------------------------------------------------------------- /docs/platform-features/assets/blueprints/blueprint.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/blueprints/blueprint.png -------------------------------------------------------------------------------- /docs/platform-features/assets/blueprints/relations.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/blueprints/relations.png -------------------------------------------------------------------------------- /docs/platform-features/assets/blueprints/resource.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/blueprints/resource.png -------------------------------------------------------------------------------- /docs/platform-features/assets/resolve-technical-debt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/resolve-technical-debt.png -------------------------------------------------------------------------------- /docs/platform-features/assets/service-level-technical-debt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/service-level-technical-debt.png -------------------------------------------------------------------------------- /docs/platform-features/assets/technical-debt-grid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/platform-features/assets/technical-debt-grid.png -------------------------------------------------------------------------------- /docs/plugins/assets/amplication-plugin-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/amplication-plugin-template.png -------------------------------------------------------------------------------- /docs/plugins/assets/create-new-repo-from-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/create-new-repo-from-template.png -------------------------------------------------------------------------------- /docs/plugins/assets/guides/another-database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/guides/another-database.png -------------------------------------------------------------------------------- /docs/plugins/assets/guides/choose-your-database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/guides/choose-your-database.png -------------------------------------------------------------------------------- /docs/plugins/assets/guides/db-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/guides/db-settings.png -------------------------------------------------------------------------------- /docs/plugins/assets/heirarchy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/heirarchy.png -------------------------------------------------------------------------------- /docs/plugins/assets/hierarchy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/hierarchy.png -------------------------------------------------------------------------------- /docs/plugins/assets/installed-plugins2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/installed-plugins2.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/add-new-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/add-new-plugin.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/add-new-version.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/add-new-version.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/add-private-plugin-to-service.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/add-private-plugin-to-service.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/configure-git-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/configure-git-settings.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/dotnet-postgres-db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/dotnet-postgres-db.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/plugin-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/plugin-template.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/private-plugins-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/private-plugins-repo.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/publish-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/publish-changes.png -------------------------------------------------------------------------------- /docs/plugins/assets/private-plugins/settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/assets/private-plugins/settings.png -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-admin-dot-env.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-admin-dot-env 3 | title: Create Admin Dot Env | .NET Plugin Event 4 | description: Creates the .env file for the admin UI. 5 | sidebar_label: Create Admin Dot Env 6 | slug: /plugins/dotnet-plugin-events/create-admin-dot-env 7 | --- 8 | 9 | # Create Admin Dot Env 10 | 11 | 12 | Creates the .env file for the admin UI. 13 | 14 | ### Event Name 15 | 16 | `CreateAdminDotEnv` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateAdminDotEnvParams extends EventParams { 22 | envVariables: VariableDictionary; 23 | } 24 | ``` 25 | 26 | Example: 27 | 28 | ```ts 29 | beforeCreateAdminDotEnv( 30 | context: DsgContext, 31 | eventParams: CreateAdminDotEnvParams 32 | ) { 33 | eventParams.envVariables.push( 34 | { REACT_APP_API_URL: "http://localhost:3000/api" }, 35 | { REACT_APP_SERVER_URL: "http://localhost:3000" } 36 | ); 37 | return eventParams; 38 | } 39 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-admin-git-ignore.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-admin-git-ignore 3 | title: Create Admin Git Ignore | .NET Plugin Event 4 | description: Creates the .gitignore file for the admin UI. 5 | sidebar_label: Create Admin Git Ignore 6 | slug: /plugins/dotnet-plugin-events/create-admin-git-ignore 7 | --- 8 | 9 | # Create Admin Git Ignore 10 | 11 | 12 | Creates the .gitignore file for the admin UI. 13 | 14 | ### Event Name 15 | 16 | `CreateAdminGitIgnore` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateAdminGitIgnoreParams extends EventParams { 22 | gitignorePaths: string[]; 23 | } 24 | ``` 25 | 26 | Example: 27 | 28 | ```ts 29 | beforeCreateAdminGitIgnore( 30 | context: DsgContext, 31 | eventParams: CreateAdminGitIgnoreParams 32 | ) { 33 | eventParams.gitignorePaths.push( 34 | "node_modules", 35 | "build", 36 | ".env.local" 37 | ); 38 | return eventParams; 39 | } 40 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-admin-ui-package-json.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-admin-ui-package-json 3 | title: Create Admin UI Package Json | .NET Plugin Event 4 | description: Creates or updates the package.json file for the admin UI. 5 | sidebar_label: Create Admin UI Package Json 6 | slug: /plugins/dotnet-plugin-events/create-admin-ui-package-json 7 | --- 8 | 9 | # Create Admin UI Package Json 10 | 11 | 12 | Creates or updates the package.json file for the admin UI. 13 | 14 | ### Event Name 15 | 16 | `CreateAdminUIPackageJson` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateAdminUIPackageJsonParams extends EventParams { 22 | updateProperties: { [key: string]: any }; 23 | } 24 | ``` 25 | 26 | Example: 27 | 28 | ```ts 29 | beforeCreateAdminUIPackageJson( 30 | context: DsgContext, 31 | eventParams: CreateAdminUIPackageJsonParams 32 | ) { 33 | eventParams.updateProperties = { 34 | ...eventParams.updateProperties, 35 | "scripts": { 36 | "start": "react-scripts start", 37 | "build": "react-scripts build", 38 | "test": "react-scripts test", 39 | "eject": "react-scripts eject" 40 | } 41 | }; 42 | return eventParams; 43 | } 44 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-admin-ui.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-admin-ui 3 | title: Create Admin UI | .NET Plugin Event 4 | description: Creates the admin UI for the .NET application. 5 | sidebar_label: Create Admin UI 6 | slug: /plugins/dotnet-plugin-events/create-admin-ui 7 | --- 8 | 9 | # Create Admin UI 10 | 11 | 12 | Creates the admin UI for the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateAdminUI` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateAdminUIParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-connect-microservices.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-connect-microservices 3 | title: Create Connect Microservices | .NET Plugin Event 4 | description: Creates the configuration for connecting microservices. 5 | sidebar_label: Create Connect Microservices 6 | slug: /plugins/dotnet-plugin-events/create-connect-microservices 7 | --- 8 | 9 | # Create Connect Microservices 10 | 11 | 12 | Creates the configuration for connecting microservices. 13 | 14 | ### Event Name 15 | 16 | `CreateConnectMicroservices` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateConnectMicroservicesParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-controller-base-module-file.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-controller-base-module-file 3 | title: Create Controller Base Module File | .NET Plugin Event 4 | description: Creates a base module file for controllers in the .NET application. 5 | sidebar_label: Create Controller Base Module File 6 | slug: /plugins/dotnet-plugin-events/create-controller-base-module-file 7 | --- 8 | 9 | # Create Controller Base Module File 10 | 11 | 12 | Creates a base module file for controllers in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateControllerBaseModuleFile` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateControllerBaseModuleFileParams extends EventParams { 22 | moduleActionsAndDtos: ModuleActionsAndDtos; 23 | resourceName: string; 24 | controllerBaseModuleBasePath: string; 25 | } 26 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-controller-module-file.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-controller-module-file 3 | title: Create Controller Module File | .NET Plugin Event 4 | description: Creates a module file for controllers in the .NET application. 5 | sidebar_label: Create Controller Module File 6 | slug: /plugins/dotnet-plugin-events/create-controller-module-file 7 | --- 8 | 9 | # Create Controller Module File 10 | 11 | 12 | Creates a module file for controllers in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateControllerModuleFile` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateControllerModuleFileParams extends EventParams { 22 | moduleActionsAndDtos: ModuleActionsAndDtos; 23 | resourceName: string; 24 | controllerModuleBasePath: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateControllerModuleFile( 32 | context: DsgContext, 33 | eventParams: CreateControllerModuleFileParams, 34 | modules: ModuleMap 35 | ) { 36 | const { resourceName, controllerModuleBasePath } = eventParams; 37 | const controllerModuleFile = modules.get(controllerModuleBasePath); 38 | 39 | if (controllerModuleFile) { 40 | const updatedCode = controllerModuleFile.code + ` 41 | [ApiExplorerSettings(GroupName = "${resourceName}")] 42 | public class ${resourceName}ControllerModule : ControllerBase 43 | { 44 | // Add your custom controller logic here 45 | } 46 | `; 47 | 48 | modules.set({ 49 | path: controllerModuleBasePath, 50 | code: updatedCode 51 | }); 52 | } 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-dtos.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-dtos 3 | title: Create DTOs | .NET Plugin Event 4 | description: Creates Data Transfer Objects (DTOs) for a specific entity in the .NET application. 5 | sidebar_label: Create DTOs 6 | slug: /plugins/dotnet-plugin-events/create-d-t-os 7 | --- 8 | 9 | # Create DTOs 10 | 11 | 12 | Creates Data Transfer Objects (DTOs) for a specific entity in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateDTOs` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateDTOsParams extends EventParams { 22 | entity: Entity; 23 | dtoName: string; 24 | dtoBasePath: string; 25 | } 26 | ``` 27 | 28 | ### Example 29 | 30 | ```ts 31 | afterCreateDTOs( 32 | context: dotnetTypes.DsgContext, 33 | eventParams: dotnet.CreateDTOsParams, 34 | files: FileMap 35 | ): Promise> { 36 | const { entity, dtoName } = eventParams; 37 | const dtoFile = files.get(`DTOs/${dtoName}.cs`); 38 | if (dtoFile) { 39 | dtoFile.code.addProperty( 40 | CsharpSupport.property({ 41 | name: "LastModified", 42 | type: CsharpSupport.Types.dateTime(), 43 | }) 44 | ); 45 | } 46 | return files; 47 | } 48 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-controller-spec.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-controller-spec 3 | title: Create Entity Controller Spec | .NET Plugin Event 4 | description: Creates the controller spec file for the entity controller. 5 | sidebar_label: Create Entity Controller Spec 6 | slug: /plugins/dotnet-plugin-events/create-entity-controller-spec 7 | --- 8 | 9 | # Create Entity Controller Spec 10 | 11 | 12 | Creates the controller spec file for the entity controller. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityControllerSpec` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityControllerSpecParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateEntityControllerSpec( 32 | context: DsgContext, 33 | eventParams: CreateEntityControllerSpecParams, 34 | modules: ModuleMap 35 | ) { 36 | const { entity, resourceName, apisDir } = eventParams; 37 | const specPath = join(apisDir, "Tests", `${resourceName}ControllerTests.cs`); 38 | const specFile = modules.get(specPath); 39 | 40 | if (specFile) { 41 | const updatedCode = specFile.code.replace( 42 | "public class", 43 | "[TestClass]\npublic class" 44 | ); 45 | 46 | modules.set({ 47 | path: specPath, 48 | code: updatedCode 49 | }); 50 | } 51 | 52 | return modules; 53 | } 54 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-grpc-controller-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-grpc-controller-base 3 | title: Create Entity Grpc Controller Base | .NET Plugin Event 4 | description: Creates a base gRPC controller for entities in the .NET application. 5 | sidebar_label: Create Entity Grpc Controller Base 6 | slug: /plugins/dotnet-plugin-events/create-entity-grpc-controller-base 7 | --- 8 | 9 | # Create Entity Grpc Controller Base 10 | 11 | 12 | Creates a base gRPC controller for entities in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityGrpcControllerBase` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityGrpcControllerBaseParams extends EventParams { 22 | entity: Entity; 23 | } 24 | ``` 25 | 26 | #### entity 27 | 28 | The entity object for which the base gRPC controller is being created. 29 | 30 | Example: 31 | 32 | ```ts 33 | async afterCreateEntityGrpcControllerBase( 34 | context: DsgContext, 35 | eventParams: CreateEntityGrpcControllerBaseParams, 36 | modules: ModuleMap 37 | ) { 38 | const { entity } = eventParams; 39 | const controllerBasePath = join(context.serverDirectories.srcDirectory, "GrpcControllers", `${entity.name}GrpcControllerBase.cs`); 40 | const controllerBaseFile = modules.get(controllerBasePath); 41 | 42 | if (controllerBaseFile) { 43 | const updatedCode = controllerBaseFile.code.replace( 44 | "public abstract class", 45 | "public abstract class" 46 | ); 47 | 48 | modules.set({ 49 | path: controllerBasePath, 50 | code: updatedCode 51 | }); 52 | } 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-grpc-controller.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-grpc-controller 3 | title: Create Entity Grpc Controller | .NET Plugin Event 4 | description: Creates a gRPC controller for a specific entity in the .NET application. 5 | sidebar_label: Create Entity Grpc Controller 6 | slug: /plugins/dotnet-plugin-events/create-entity-grpc-controller 7 | --- 8 | 9 | # Create Entity Grpc Controller 10 | 11 | 12 | Creates a gRPC controller for a specific entity in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityGrpcController` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityGrpcControllerParams extends EventParams { 22 | entity: Entity; 23 | } 24 | ``` 25 | 26 | #### entity 27 | 28 | The entity object for which the gRPC controller is being created. 29 | 30 | Example: 31 | 32 | ```ts 33 | async afterCreateEntityGrpcController( 34 | context: DsgContext, 35 | eventParams: CreateEntityGrpcControllerParams, 36 | modules: ModuleMap 37 | ) { 38 | const { entity } = eventParams; 39 | const controllerPath = join(context.serverDirectories.srcDirectory, "GrpcControllers", `${entity.name}GrpcController.cs`); 40 | const controllerFile = modules.get(controllerPath); 41 | 42 | if (controllerFile) { 43 | const updatedCode = controllerFile.code.replace( 44 | "public class", 45 | "[GrpcService]\npublic class" 46 | ); 47 | 48 | modules.set({ 49 | path: controllerPath, 50 | code: updatedCode 51 | }); 52 | } 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-interface.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-interface 3 | title: Create Entity Interface | .NET Plugin Event 4 | description: Creates an interface for entities in the .NET application. 5 | sidebar_label: Create Entity Interface 6 | slug: /plugins/dotnet-plugin-events/create-entity-interface 7 | --- 8 | 9 | # Create Entity Interface 10 | 11 | 12 | Creates an interface for entities in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityInterface` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityInterfaceParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | moduleContainers: ModuleContainer[]; 26 | moduleActions: ModuleAction[]; 27 | entities: Entity[]; 28 | } 29 | ``` 30 | 31 | ### Example 32 | 33 | ```ts 34 | afterCreateEntityInterface( 35 | context: dotnetTypes.DsgContext, 36 | eventParams: dotnet.CreateEntityInterfaceParams, 37 | files: FileMap 38 | ): Promise> { 39 | const { entity } = eventParams; 40 | const interfaceFile = files.get(`Interfaces/I${entity.name}.cs`); 41 | if (interfaceFile) { 42 | interfaceFile.code.addMethod( 43 | CsharpSupport.method({ 44 | name: "Validate", 45 | returnType: CsharpSupport.Types.boolean(), 46 | }) 47 | ); 48 | } 49 | return files; 50 | } 51 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-model.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-model 3 | title: Create Entity Model | .NET Plugin Event 4 | description: Creates a model class for a specific entity in the .NET application. 5 | sidebar_label: Create Entity Model 6 | slug: /plugins/dotnet-plugin-events/create-entity-model 7 | --- 8 | 9 | # Create Entity Model 10 | 11 | 12 | Creates a model class for a specific entity in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityModel` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityModelParams extends EventParams { 22 | entity: Entity; 23 | entities: Entity[]; 24 | resourceName: string; 25 | apisDir: string; 26 | } 27 | ``` 28 | 29 | ### Example 30 | 31 | ```ts 32 | afterCreateEntityModel( 33 | context: dotnetTypes.DsgContext, 34 | eventParams: dotnet.CreateEntityModelParams, 35 | files: FileMap 36 | ): Promise> { 37 | const { entity, resourceName } = eventParams; 38 | const modelFile = files.get(`${resourceName}/Models/${entity.name}.cs`); 39 | if (modelFile) { 40 | modelFile.code.addAttribute( 41 | CsharpSupport.attribute({ 42 | name: "Table", 43 | arguments: [`"${entity.name}s"`], 44 | }) 45 | ); 46 | } 47 | return files; 48 | } 49 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-module-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-module-base 3 | title: Create Entity Module Base | .NET Plugin Event 4 | description: Creates a base module for entities in the .NET application. 5 | sidebar_label: Create Entity Module Base 6 | slug: /plugins/dotnet-plugin-events/create-entity-module-base 7 | --- 8 | 9 | # Create Entity Module Base 10 | 11 | 12 | Creates a base module for entities in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityModuleBase` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityModuleBaseParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateEntityModuleBase( 32 | context: DsgContext, 33 | eventParams: CreateEntityModuleBaseParams, 34 | modules: ModuleMap 35 | ) { 36 | const { resourceName, apisDir } = eventParams; 37 | const moduleBasePath = join(apisDir, `${resourceName}ModuleBase.cs`); 38 | const moduleBaseFile = modules.get(moduleBasePath); 39 | 40 | if (moduleBaseFile) { 41 | const updatedCode = moduleBaseFile.code + ` 42 | protected virtual void ConfigureAdditionalServices(IServiceCollection services) 43 | { 44 | // Add additional service configuration here 45 | } 46 | `; 47 | 48 | modules.set({ 49 | path: moduleBasePath, 50 | code: updatedCode 51 | }); 52 | } 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-module 3 | title: Create Entity Module | .NET Plugin Event 4 | description: Creates a module for a specific entity in the .NET application. 5 | sidebar_label: Create Entity Module 6 | slug: /plugins/dotnet-plugin-events/create-entity-module 7 | --- 8 | 9 | # Create Entity Module 10 | 11 | 12 | Creates a module for a specific entity in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityModule` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityModuleParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateEntityModule( 32 | context: DsgContext, 33 | eventParams: CreateEntityModuleParams, 34 | modules: ModuleMap 35 | ) { 36 | const { resourceName, apisDir } = eventParams; 37 | const modulePath = join(apisDir, `${resourceName}Module.cs`); 38 | const moduleFile = modules.get(modulePath); 39 | 40 | if (moduleFile) { 41 | const updatedCode = moduleFile.code.replace( 42 | "public class", 43 | "[Module]\npublic class" 44 | ); 45 | 46 | modules.set({ 47 | path: modulePath, 48 | code: updatedCode 49 | }); 50 | } 51 | 52 | return modules; 53 | } 54 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-resolver-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-resolver-base 3 | title: Create Entity Resolver Base | .NET Plugin Event 4 | description: Creates a base resolver for entities in the .NET application. 5 | sidebar_label: Create Entity Resolver Base 6 | slug: /plugins/dotnet-plugin-events/create-entity-resolver-base 7 | --- 8 | 9 | # Create Entity Resolver Base 10 | 11 | 12 | Creates a base resolver for entities in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityResolverBase` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityResolverBaseParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateEntityResolverBase( 32 | context: DsgContext, 33 | eventParams: CreateEntityResolverBaseParams, 34 | modules: ModuleMap 35 | ) { 36 | const { resourceName, apisDir } = eventParams; 37 | const resolverBasePath = join(apisDir, `${resourceName}ResolverBase.cs`); 38 | const resolverBaseFile = modules.get(resolverBasePath); 39 | 40 | if (resolverBaseFile) { 41 | const updatedCode = resolverBaseFile.code + ` 42 | protected virtual IQueryable ApplyDefaultOrdering(IQueryable query) 43 | { 44 | return query.OrderBy(e => e.Id); 45 | } 46 | `; 47 | 48 | modules.set({ 49 | path: resolverBasePath, 50 | code: updatedCode 51 | }); 52 | } 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-resolver.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-resolver 3 | title: Create Entity Resolver | .NET Plugin Event 4 | description: Creates a resolver for a specific entity in the .NET application. 5 | sidebar_label: Create Entity Resolver 6 | slug: /plugins/dotnet-plugin-events/create-entity-resolver 7 | --- 8 | 9 | # Create Entity Resolver 10 | 11 | 12 | Creates a resolver for a specific entity in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityResolver` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityResolverParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | async afterCreateEntityResolver( 32 | context: DsgContext, 33 | eventParams: CreateEntityResolverParams, 34 | modules: ModuleMap 35 | ) { 36 | const { resourceName, apisDir } = eventParams; 37 | const resolverPath = join(apisDir, `${resourceName}Resolver.cs`); 38 | const resolverFile = modules.get(resolverPath); 39 | 40 | if (resolverFile) { 41 | const updatedCode = resolverFile.code.replace( 42 | "public class", 43 | "[GraphQLResolver]\npublic class" 44 | ); 45 | 46 | modules.set({ 47 | path: resolverPath, 48 | code: updatedCode 49 | }); 50 | } 51 | 52 | return modules; 53 | } 54 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-entity-service-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-service-base 3 | title: Create Entity Service Base | .NET Plugin Event 4 | description: Creates a base service for entities in the .NET application. 5 | sidebar_label: Create Entity Service Base 6 | slug: /plugins/dotnet-plugin-events/create-entity-service-base 7 | --- 8 | 9 | # Create Entity Service Base 10 | 11 | 12 | Creates a base service for entities in the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateEntityServiceBase` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateEntityServiceBaseParams extends EventParams { 22 | entity: Entity; 23 | resourceName: string; 24 | apisDir: string; 25 | moduleActions: ModuleAction[]; 26 | entities: Entity[]; 27 | } 28 | ``` 29 | 30 | ### Example 31 | 32 | ```ts 33 | afterCreateEntityServiceBase( 34 | context: dotnetTypes.DsgContext, 35 | eventParams: dotnet.CreateEntityServiceBaseParams, 36 | files: FileMap 37 | ): Promise> { 38 | const { entity } = eventParams; 39 | const serviceBaseFile = files.get(`Services/Base/${entity.name}ServiceBase.cs`); 40 | if (serviceBaseFile) { 41 | serviceBaseFile.code.addMethod( 42 | CsharpSupport.method({ 43 | name: "SoftDelete", 44 | access: "protected", 45 | returnType: CsharpSupport.Types.task(CsharpSupport.Types.void()), 46 | parameters: [ 47 | CsharpSupport.parameter({ 48 | name: "id", 49 | type: CsharpSupport.Types.string(), 50 | }), 51 | ], 52 | body: "// Implement soft delete logic here", 53 | }) 54 | ); 55 | } 56 | return files; 57 | } 58 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker-client-options-factory.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-client-options-factory 3 | title: Create Message Broker Client Options Factory | .NET Plugin Event 4 | description: Creates the client options factory for the message broker. 5 | sidebar_label: Create Message Broker Client Options Factory 6 | slug: /plugins/dotnet-plugin-events/create-message-broker-client-options-factory 7 | --- 8 | 9 | # Create Message Broker Client Options Factory 10 | 11 | 12 | Creates the client options factory for the message broker. 13 | 14 | ### Event Name 15 | 16 | `CreateMessageBrokerClientOptionsFactory` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateMessageBrokerClientOptionsFactoryParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. 25 | 26 | ### Example 27 | 28 | 29 | ```ts 30 | afterCreateMessageBrokerClientOptionsFactory( 31 | context: dotnetTypes.DsgContext, 32 | eventParams: dotnet.CreateMessageBrokerClientOptionsFactoryParams, 33 | files: FileMap 34 | ): Promise> { 35 | const optionsFactoryFile = files.get("MessageBroker/MessageBrokerClientOptionsFactory.cs"); 36 | if (optionsFactoryFile) { 37 | optionsFactoryFile.code.addMethod( 38 | CsharpSupport.method({ 39 | name: "CreateConsumerConfig", 40 | access: "public", 41 | returnType: CsharpSupport.Types.reference("ConsumerConfig"), 42 | body: "return new ConsumerConfig { GroupId = \"my-consumer-group\" };", 43 | }) 44 | ); 45 | } 46 | return files; 47 | } 48 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker-nest-j-s-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-nest-j-s-module 3 | title: Create Message Broker Nest J S Module | .NET Plugin Event 4 | description: Creates the NestJS module for the message broker. 5 | sidebar_label: Create Message Broker Nest J S Module 6 | slug: /plugins/dotnet-plugin-events/create-message-broker-nest-j-s-module 7 | --- 8 | 9 | # Create Message Broker Nest J S Module 10 | 11 | 12 | Creates the NestJS module for the message broker. 13 | 14 | :::note 15 | This event is typically not used in .NET projects 16 | ::: 17 | 18 | ### Event Name 19 | 20 | `CreateMessageBrokerNestJSModule` 21 | 22 | ### Event Params 23 | 24 | ```ts 25 | export interface CreateMessageBrokerNestJSModuleParams extends EventParams {} 26 | ``` 27 | 28 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker-service-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-service-base 3 | title: Create Message Broker Service Base | .NET Plugin Event 4 | description: Creates the base service for the message broker. 5 | sidebar_label: Create Message Broker Service Base 6 | slug: /plugins/dotnet-plugin-events/create-message-broker-service-base 7 | --- 8 | 9 | # Create Message Broker Service Base 10 | 11 | 12 | Creates the base service for the message broker. 13 | 14 | ### Event Name 15 | 16 | `CreateMessageBrokerServiceBase` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateMessageBrokerServiceBaseParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker-service.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-service 3 | title: Create Message Broker Service | .NET Plugin Event 4 | description: Creates the service for the message broker. 5 | sidebar_label: Create Message Broker Service 6 | slug: /plugins/dotnet-plugin-events/create-message-broker-service 7 | --- 8 | 9 | # Create Message Broker Service 10 | 11 | 12 | Creates the service for the message broker. 13 | 14 | ### Event Name 15 | 16 | `CreateMessageBrokerService` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateMessageBrokerServiceParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. 25 | 26 | ### Example 27 | 28 | ```ts 29 | async afterCreateMessageBrokerService( 30 | dsgContext: dotnetTypes.DsgContext, 31 | eventParams: dotnet.CreateMessageBrokerServiceParams, 32 | files: FileMap 33 | ): Promise> { 34 | const messageBrokerFiles = await createMessageBroker(dsgContext); 35 | await files.merge(messageBrokerFiles); 36 | return files; 37 | } 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker-topics-enum.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-topics-enum 3 | title: Create Message Broker Topics Enum | .NET Plugin Event 4 | description: Creates the message broker topics enum. 5 | sidebar_label: Create Message Broker Topics Enum 6 | slug: /plugins/dotnet-plugin-events/create-message-broker-topics-enum 7 | --- 8 | 9 | # Create Message Broker Topics Enum 10 | 11 | 12 | Creates the message broker topics enum. 13 | 14 | ### Event Name 15 | 16 | `CreateMessageBrokerTopicsEnum` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateMessageBrokerTopicsEnumParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-message-broker.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker 3 | title: Create Message Broker | .NET Plugin Event 4 | description: Sets up the message broker configuration for the .NET server. 5 | sidebar_label: Create Message Broker 6 | slug: /plugins/dotnet-plugin-events/create-message-broker 7 | --- 8 | 9 | # Create Message Broker 10 | 11 | 12 | Sets up the message broker configuration for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateMessageBroker` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateMessageBrokerParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-prisma-schema.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-prisma-schema 3 | title: Create Prisma Schema | .NET Plugin Event 4 | description: Creates the Prisma schema for the application. 5 | sidebar_label: Create Prisma Schema 6 | slug: /plugins/dotnet-plugin-events/create-prisma-schema 7 | --- 8 | 9 | # Create Prisma Schema 10 | 11 | 12 | Creates the Prisma schema for the application. 13 | 14 | ### Event Name 15 | 16 | `CreatePrismaSchema` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreatePrismaSchemaParams extends EventParams { 22 | entities: Entity[]; 23 | dataSource: PrismaDataSource; 24 | clientGenerator: PrismaClientGenerator; 25 | } 26 | ``` 27 | 28 | Example: 29 | 30 | ```ts 31 | beforeCreatePrismaSchema( 32 | context: DsgContext, 33 | eventParams: CreatePrismaSchemaParams 34 | ) { 35 | // Modify Prisma schema generation 36 | return eventParams; 37 | } 38 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-program-file.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-program-file 3 | title: Create Program File | .NET Plugin Event 4 | description: Creates the main Program.cs file for the .NET application. 5 | sidebar_label: Create Program File 6 | slug: /plugins/dotnet-plugin-events/create-program-file 7 | --- 8 | 9 | # Create Program File 10 | 11 | 12 | Creates the main Program.cs file for the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateProgramFile` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateProgramFileParams extends EventParams { 22 | builderServicesBlocks: CodeBlock[]; 23 | appBlocks: CodeBlock[]; 24 | } 25 | ``` 26 | 27 | ### Example 28 | 29 | ```ts 30 | beforeCreateProgramFile( 31 | { resourceInfo }: dotnetTypes.DsgContext, 32 | eventParams: dotnet.CreateProgramFileParams 33 | ) { 34 | const serviceNamespace = pascalCase(resourceInfo?.name ?? ""); 35 | const serviceDbContext = `${pascalCase(resourceInfo?.name ?? "")}DbContext`; 36 | eventParams.builderServicesBlocks.push( 37 | new CodeBlock({ 38 | code: `builder.Services.AddDbContext<${serviceDbContext}>(opt => opt.UseNpgsql(builder.Configuration.GetConnectionString("${CONNECTION_STRING}")));`, 39 | references: [ 40 | new ClassReference({ 41 | name: "AddDbContext", 42 | namespace: "Microsoft.EntityFrameworkCore", 43 | }), 44 | new ClassReference({ 45 | name: serviceDbContext, 46 | namespace: `${serviceNamespace}.Infrastructure`, 47 | }), 48 | ], 49 | }) 50 | ); 51 | 52 | return eventParams; 53 | } 54 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-resource-db-context-file.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-resource-db-context-file 3 | title: Create Resource Db Context File | .NET Plugin Event 4 | description: Creates the database context file for the .NET application. 5 | sidebar_label: Create Resource Db Context File 6 | slug: /plugins/dotnet-plugin-events/create-resource-db-context-file 7 | --- 8 | 9 | # Create Resource Db Context File 10 | 11 | 12 | Creates the database context file for the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateResourceDbContextFile` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateResourceDbContextFileParams extends EventParams { 22 | entities: Entity[]; 23 | resourceName: string; 24 | resourceDbContextPath: string; 25 | } 26 | ``` 27 | 28 | ### Example 29 | 30 | ```ts 31 | afterCreateResourceDbContextFile( 32 | context: dotnetTypes.DsgContext, 33 | eventParams: dotnet.CreateResourceDbContextFileParams, 34 | files: FileMap 35 | ): FileMap { 36 | const { resourceDbContextPath, resourceName } = eventParams; 37 | 38 | const modelFile = files.get( 39 | `${resourceDbContextPath}${resourceName}DbContext.cs` 40 | ); 41 | 42 | if (!modelFile) return files; 43 | 44 | modelFile.code.parentClassReference = CsharpSupport.genericClassReference({ 45 | reference: CsharpSupport.classReference({ 46 | name: `IdentityDbContext`, 47 | namespace: "Microsoft.AspNetCore.Identity.EntityFrameworkCore", 48 | }), 49 | innerType: CsharpSupport.Types.reference( 50 | CsharpSupport.classReference({ 51 | name: `IdentityUser`, 52 | namespace: "Microsoft.AspNetCore.Identity", 53 | }) 54 | ), 55 | }); 56 | 57 | return files; 58 | } 59 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-app-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-app-module 3 | title: Create Server App Module | .NET Plugin Event 4 | description: Creates the main application module for the .NET server. 5 | sidebar_label: Create Server App Module 6 | slug: /plugins/dotnet-plugin-events/create-server-app-module 7 | --- 8 | 9 | # Create Server App Module 10 | 11 | 12 | Creates the main application module for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerAppModule` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerAppModuleParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-appsettings.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-appsettings 3 | title: Create Server Appsettings | .NET Plugin Event 4 | description: Creates or updates the appsettings.json file for the .NET server. 5 | sidebar_label: Create Server Appsettings 6 | slug: /plugins/dotnet-plugin-events/create-server-appsettings 7 | --- 8 | 9 | # Create Server Appsettings 10 | 11 | 12 | Creates or updates the appsettings.json file for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerAppsettings` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerAppsettingsParams extends EventParams { 22 | updateProperties: { [key: string]: any }; 23 | } 24 | ``` 25 | 26 | ### Example 27 | 28 | ```ts 29 | beforeCreateServerAppsettings( 30 | context: dotnetTypes.DsgContext, 31 | eventParams: dotnet.CreateServerAppsettingsParams 32 | ) { 33 | const { port, password, user, host, dbName } = getPluginSettings( 34 | context.pluginInstallations 35 | ); 36 | 37 | eventParams.updateProperties = { 38 | ...eventParams.updateProperties, 39 | ConnectionStrings: { 40 | [CONNECTION_STRING]: `Host=${host}:${port};Username=${user};Password=${password};Database=${dbName}`, 41 | }, 42 | }; 43 | return eventParams; 44 | } 45 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-auth.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-auth 3 | title: Create Server Auth | .NET Plugin Event 4 | description: Sets up authentication for the .NET server. 5 | sidebar_label: Create Server Auth 6 | slug: /plugins/dotnet-plugin-events/create-server-auth 7 | --- 8 | 9 | # Create Server Auth 10 | 11 | 12 | Sets up authentication for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerAuth` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerAuthParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. 25 | 26 | ### Example 27 | 28 | ```ts 29 | afterCreateServerAuth( 30 | context: dotnetTypes.DsgContext, 31 | eventParams: dotnet.CreateServerAuthParams, 32 | files: FileMap 33 | ): Promise> { 34 | const authFile = files.get("Auth/AuthService.cs"); 35 | if (authFile) { 36 | authFile.code.addMethod( 37 | CsharpSupport.method({ 38 | name: "ValidateToken", 39 | access: "public", 40 | returnType: CsharpSupport.Types.boolean(), 41 | parameters: [ 42 | CsharpSupport.parameter({ 43 | name: "token", 44 | type: CsharpSupport.Types.string(), 45 | }), 46 | ], 47 | body: "// Add token validation logic here\nreturn true;", 48 | }) 49 | ); 50 | } 51 | return files; 52 | } 53 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-csproj.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-csproj 3 | title: Create Server Csproj | .NET Plugin Event 4 | description: Creates or updates the .csproj file for the .NET server. 5 | sidebar_label: Create Server Csproj 6 | slug: /plugins/dotnet-plugin-events/create-server-csproj 7 | --- 8 | 9 | # Create Server Csproj 10 | 11 | 12 | Creates or updates the .csproj file for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerCsproj` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerCsprojParams extends EventParams { 22 | propertyGroup: Record; 23 | packageReferences: { 24 | include: string; 25 | version: string; 26 | includeAssets?: string; 27 | privateAssets?: string; 28 | }[]; 29 | } 30 | ``` 31 | 32 | ### Example 33 | 34 | ```ts 35 | beforeCreateServerCsproj( 36 | _: dotnetTypes.DsgContext, 37 | eventParams: dotnet.CreateServerCsprojParams 38 | ) { 39 | eventParams.packageReferences.push({ 40 | include: "Npgsql.EntityFrameworkCore.PostgreSQL", 41 | version: "8.0.4", 42 | }); 43 | 44 | return eventParams; 45 | } 46 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-docker-compose.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-docker-compose 3 | title: Create Server Docker Compose | .NET Plugin Event 4 | description: Creates or updates the Docker Compose file for the .NET server. 5 | sidebar_label: Create Server Docker Compose 6 | slug: /plugins/dotnet-plugin-events/create-server-docker-compose 7 | --- 8 | 9 | # Create Server Docker Compose 10 | 11 | 12 | Creates or updates the Docker Compose file for the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerDockerCompose` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerDockerComposeParams extends EventParams { 22 | fileContent: string; 23 | updateProperties: { [key: string]: any }[]; 24 | outputFileName: string; 25 | } 26 | ``` 27 | 28 | ### Example 29 | 30 | ```ts 31 | beforeCreateServerDockerCompose( 32 | context: dotnetTypes.DsgContext, 33 | eventParams: dotnet.CreateServerDockerComposeParams 34 | ) { 35 | const settings = getPluginSettings(context.pluginInstallations); 36 | 37 | eventParams.updateProperties.push( 38 | ...updateDockerComposeProperties(settings) 39 | ); 40 | return eventParams; 41 | } 42 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-git-ignore.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-git-ignore 3 | title: Create Server Git Ignore | .NET Plugin Event 4 | description: Creates the .gitignore file for the server. 5 | sidebar_label: Create Server Git Ignore 6 | slug: /plugins/dotnet-plugin-events/create-server-git-ignore 7 | --- 8 | 9 | # Create Server Git Ignore 10 | 11 | 12 | Creates the .gitignore file for the server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerGitIgnore` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerGitIgnoreParams extends EventParams { 22 | gitignorePaths: string[]; 23 | } 24 | ``` 25 | 26 | ### Example 27 | 28 | ```ts 29 | beforeCreateServerGitIgnore( 30 | context: dotnetTypes.DsgContext, 31 | eventParams: dotnet.CreateServerGitIgnoreParams 32 | ): Promise { 33 | eventParams.gitignorePaths.push( 34 | "*.user", 35 | "*.userosscache", 36 | "*.sln.docstates", 37 | "[Tt]est[Rr]esult*" 38 | ); 39 | return eventParams; 40 | } 41 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server-secrets-manager.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-secrets-manager 3 | title: Create Server Secrets Manager | .NET Plugin Event 4 | description: Creates the configuration for the secrets manager in the server. 5 | sidebar_label: Create Server Secrets Manager 6 | slug: /plugins/dotnet-plugin-events/create-server-secrets-manager 7 | --- 8 | 9 | # Create Server Secrets Manager 10 | 11 | 12 | Creates the configuration for the secrets manager in the server. 13 | 14 | ### Event Name 15 | 16 | `CreateServerSecretsManager` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerSecretsManagerParams extends EventParams { 22 | secretsNameKey: SecretsNameKey[]; 23 | } 24 | ``` 25 | 26 | Example: 27 | 28 | ```ts 29 | async afterCreateServerSecretsManager( 30 | context: DsgContext, 31 | eventParams: CreateServerSecretsManagerParams, 32 | modules: ModuleMap 33 | ) { 34 | const { secretsNameKey } = eventParams; 35 | const secretsManager = ` 36 | public static class SecretsManager 37 | { 38 | public enum SecretsNameKey 39 | { 40 | ${secretsNameKey.map(snk => `${snk.name} = "${snk.key}"`).join(',\n ')} 41 | } 42 | 43 | public static string GetSecret(SecretsNameKey key) 44 | { 45 | // Implement secret retrieval logic here 46 | return Environment.GetEnvironmentVariable(key.ToString()); 47 | } 48 | } 49 | `; 50 | 51 | modules.set({ 52 | path: join(context.serverDirectories.srcDirectory, "SecretsManager.cs"), 53 | code: secretsManager 54 | }); 55 | 56 | return modules; 57 | } 58 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server 3 | title: Create Server | .NET Plugin Event 4 | description: Initializes the creation of the .NET server. 5 | sidebar_label: Create Server 6 | slug: /plugins/dotnet-plugin-events/create-server 7 | --- 8 | 9 | # Create Server 10 | 11 | 12 | Initializes the creation of the .NET server. 13 | 14 | ### Event Name 15 | 16 | `CreateServer` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateServerParams extends EventParams {} 22 | ``` 23 | 24 | This event does not use any additional parameters. -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/create-swagger.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-swagger 3 | title: Create Swagger | .NET Plugin Event 4 | description: Creates the Swagger configuration for the .NET application. 5 | sidebar_label: Create Swagger 6 | slug: /plugins/dotnet-plugin-events/create-swagger 7 | --- 8 | 9 | # Create Swagger 10 | 11 | 12 | Creates the Swagger configuration for the .NET application. 13 | 14 | ### Event Name 15 | 16 | `CreateSwagger` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface CreateSwaggerParams extends EventParams { 22 | fileDir: string; 23 | outputFileName: string; 24 | } 25 | ``` 26 | 27 | Example: 28 | 29 | ```ts 30 | async afterCreateSwagger( 31 | context: DsgContext, 32 | eventParams: CreateSwaggerParams, 33 | modules: ModuleMap 34 | ) { 35 | const { fileDir, outputFileName } = eventParams; 36 | const swaggerConfig = ` 37 | public static class SwaggerConfig 38 | { 39 | public static void ConfigureSwagger(this IServiceCollection services) 40 | { 41 | services.AddSwaggerGen(c => 42 | { 43 | c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); 44 | }); 45 | } 46 | } 47 | `; 48 | 49 | modules.set({ 50 | path: join(fileDir, outputFileName), 51 | code: swaggerConfig 52 | }); 53 | 54 | return modules; 55 | } 56 | ``` -------------------------------------------------------------------------------- /docs/plugins/dotnet-plugin-events/load-static-files.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: load-static-files 3 | title: Load Static Files | .NET Plugin Event 4 | description: Loads static files into the project. 5 | sidebar_label: Load Static Files 6 | slug: /plugins/dotnet-plugin-events/load-static-files 7 | --- 8 | 9 | # Load Static Files 10 | 11 | 12 | Loads static files into the project. 13 | 14 | ### Event Name 15 | 16 | `LoadStaticFiles` 17 | 18 | ### Event Params 19 | 20 | ```ts 21 | export interface LoadStaticFilesParams extends EventParams { 22 | source: string; 23 | basePath: string; 24 | } 25 | ``` 26 | 27 | ### Example 28 | 29 | ```ts 30 | async afterLoadStaticFiles( 31 | context: dotnetTypes.DsgContext, 32 | eventParams: dotnet.LoadStaticFilesParams, 33 | files: FileMap 34 | ): Promise> { 35 | const { resourceInfo } = context; 36 | if (!resourceInfo) return files; 37 | 38 | const resourceName = pascalCase(resourceInfo.name); 39 | 40 | const destPath = `${eventParams.basePath}/src/APIs/Common/Auth/ProgramAuthExtensions.cs`; 41 | const filePath = resolve( 42 | __dirname, 43 | "./static/common/auth/ProgramAuthExtensions.cs" 44 | ); 45 | 46 | const programAuthExtensionsFileMap = await createStaticFileFileMap( 47 | destPath, 48 | filePath, 49 | context, 50 | [ 51 | CsharpSupport.classReference({ 52 | name: `${resourceName}DbContext`, 53 | namespace: `${resourceName}.Infrastructure`, 54 | }), 55 | ] 56 | ); 57 | 58 | return files; 59 | } 60 | ``` -------------------------------------------------------------------------------- /docs/plugins/event-create-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-event 3 | title: Creating a Server Event 4 | sidebar_label: Creating a Server Event 5 | slug: /plugins/server-event 6 | --- 7 | 8 | Coming soon -------------------------------------------------------------------------------- /docs/plugins/plugin-events/assets/dbsettings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/plugins/plugin-events/assets/dbsettings.png -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-auth-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-auth-module 3 | title: CreateAuthModels 4 | sidebar_label: CreateAuthModels 5 | slug: /plugins/plugin-events/create-auth-module 6 | --- 7 | 8 | # Create Server Auth 9 | 10 | ## Description 11 | 12 | [description] 13 | 14 | ## Event Params 15 | 16 | ```javascript 17 | [code] 18 | } 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-entity-resolver-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-entity-resolver-base 3 | title: Create Entity Resolver Base 4 | sidebar_label: Create Entity Resolver Base 5 | slug: /plugins/plugin-events/create-entity-resolver-base 6 | --- 7 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-client-options-factory.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-client-options-factory 3 | title: Create Message Broker Client Options Factory | Plugin Event 4 | description: Creates the client options of the message broker. 5 | sidebar_label: Create Message Broker Client Options Factory 6 | slug: /plugins/plugin-events/create-message-broker-client-options-factory 7 | --- 8 | 9 | # Create Message Broker Client Options Factory 10 | 11 | ## Description 12 | 13 | Creates the client options of the message broker. 14 | 15 | This event does NOTHING by default. All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBrokerClientOptionsFactory` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```ts 26 | export interface CreateMessageBrokerClientOptionsFactoryParams 27 | extends EventParams {} 28 | ``` 29 | 30 | Example: 31 | 32 | ```ts 33 | async afterCreateMessageBrokerClientOptionsFactory( 34 | context: DsgContext, 35 | eventParams: CreateMessageBrokerClientOptionsFactoryParams, 36 | modules: ModuleMap 37 | ): Promise { 38 | const { serverDirectories } = context; 39 | const filePath = resolve(staticDirectory, "generateKafkaClientOptions.ts"); 40 | const file = await readFile(filePath, "utf8"); 41 | const generateFileName = "generateKafkaClientOptions.ts"; 42 | 43 | const path = join( 44 | serverDirectories.messageBrokerDirectory, 45 | generateFileName 46 | ); 47 | modules.set({ code: file, path }); 48 | return modules; 49 | } 50 | ``` 51 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-nest-js-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-nest-js-module 3 | title: CreateMessageBrokerNestJSModule 4 | sidebar_label: CreateMessageBrokerNestJSModule 5 | slug: /plugins/plugin-events/create-message-broker-nest-js-module 6 | --- 7 | 8 | # Create Message Broker NestJS Module 9 | 10 | ## Description 11 | 12 | [description] 13 | 14 | ## Event Params 15 | 16 | ```javascript 17 | [code] 18 | } 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-nestjs-module.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-nestjs-module 3 | title: Create Message Broker NestJS Module | Plugin Event 4 | description: Creates the NestJS of the message broker. 5 | sidebar_label: Create Message Broker NestJS Module 6 | slug: /plugins/plugin-events/create-message-broker-nestjs-module 7 | --- 8 | 9 | # Create Message Broker NestJS Module 10 | 11 | ## Description 12 | 13 | Creates the NestJS of the message broker. 14 | 15 | This event does NOTHING by default. All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBrokerNestJSModule` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```ts 26 | export interface CreateMessageBrokerNestJSModuleParams extends EventParams {} 27 | ``` 28 | 29 | Example: 30 | 31 | ```ts 32 | async afterCreateMessageBrokerNestJSModule( 33 | context: DsgContext, 34 | eventParams: CreateMessageBrokerNestJSModuleParams, 35 | modules: ModuleMap 36 | ) { 37 | const filePath = resolve(staticDirectory, "kafka.module.ts"); 38 | 39 | const { serverDirectories } = context; 40 | const { messageBrokerDirectory } = serverDirectories; 41 | const file = await readFile(filePath, "utf8"); 42 | const generateFileName = "kafka.module.ts"; 43 | 44 | this.moduleFile = { 45 | code: file, 46 | path: join(messageBrokerDirectory, generateFileName), 47 | }; 48 | 49 | return modules.set(this.moduleFile); 50 | } 51 | ``` 52 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-service-base.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-service-base 3 | title: Create Message Broker Service Base | Plugin Event 4 | description: Creates the base service of th Kafka message broker. 5 | sidebar_label: Create Message Broker Service Base 6 | slug: /plugins/plugin-events/create-message-broker-service-base 7 | --- 8 | 9 | # Create Message Broker Service Base 10 | 11 | ## Description 12 | 13 | Creates the base service of the Kafka message broker. 14 | 15 | This event does NOTHING by default. All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBrokerServiceBase` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```ts 26 | export interface CreateMessageBrokerServiceBaseParams extends EventParams {} 27 | ``` 28 | 29 | Example: 30 | 31 | ```ts 32 | async afterCreateMessageBrokerServiceBase( 33 | context: DsgContext, 34 | eventParams: CreateMessageBrokerServiceBaseParams, 35 | modules: ModuleMap 36 | ): Promise { 37 | const { serverDirectories } = context; 38 | const { messageBrokerDirectory } = serverDirectories; 39 | const filePath = resolve(staticDirectory, `kafka.service.base.ts`); 40 | 41 | const file = await readFile(filePath, "utf8"); 42 | const generateFileName = `kafka.service.base.ts`; 43 | 44 | const path = join(messageBrokerDirectory, "base", generateFileName); 45 | modules.set({ code: file, path }); 46 | return modules; 47 | } 48 | ``` 49 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-service.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-service 3 | title: Create Message Broker Service | Plugin Event 4 | description: Creates the service of the Kafka message broker. 5 | sidebar_label: Create Message Broker Service 6 | slug: /plugins/plugin-events/create-message-broker-service 7 | --- 8 | 9 | # Create Message Broker Service 10 | 11 | ## Description 12 | 13 | Creates the service of the Kafka message broker. 14 | 15 | This event does NOTHING by default. All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBrokerService` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```ts 26 | export interface CreateMessageBrokerServiceParams extends EventParams {} 27 | ``` 28 | 29 | Example: 30 | 31 | ```ts 32 | async afterCreateMessageBrokerService( 33 | context: DsgContext, 34 | eventParams: CreateMessageBrokerServiceParams, 35 | modules: ModuleMap 36 | ): Promise { 37 | const { serverDirectories } = context; 38 | const { messageBrokerDirectory } = serverDirectories; 39 | const filePath = resolve(staticDirectory, `kafka.service.ts`); 40 | 41 | const file = await readFile(filePath, "utf8"); 42 | const generateFileName = `kafka.service.ts`; 43 | 44 | const path = join(messageBrokerDirectory, generateFileName); 45 | modules.set({ code: file, path }); 46 | return modules; } 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker-topics-enum.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker-topics-enum 3 | title: Create Message Broker Topics Enum | Plugin Event 4 | description: Creates the message broker topics enum. 5 | sidebar_label: Create Message Broker Topics Enum 6 | slug: /plugins/plugin-events/create-message-broker-topics-enum 7 | --- 8 | 9 | # Create Message Broker Topic Enum 10 | 11 | ## Description 12 | 13 | Creates the message broker topics enum. 14 | 15 | All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBrokerTopicsEnum` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```tsx 26 | export interface CreateMessageBrokerTopicsEnumParams extends EventParams {} 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-message-broker.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-message-broker 3 | title: Create Message Broker | Plugin Event 4 | description: Creates the message broker. 5 | sidebar_label: Create Message Broker 6 | slug: /plugins/plugin-events/create-message-broker 7 | --- 8 | 9 | # Create Message Broker 10 | 11 | ## Description 12 | 13 | Creates the message broker. 14 | 15 | This event does NOTHING by default. All of the logic is handled by the broker-kafka plugin https://github.com/amplication/plugins/tree/master/plugins/broker-kafka 16 | 17 | ## Event Name 18 | 19 | `CreateMessageBroker` 20 | 21 | ## Event Params 22 | 23 | There are no additional params to this event 24 | 25 | ```ts 26 | export interface CreateMessageBrokerParams extends EventParams {} 27 | ``` 28 | 29 | Example: 30 | 31 | ```ts 32 | beforeCreateBroker( 33 | dsgContext: DsgContext, 34 | eventParams: CreateMessageBrokerParams 35 | ): CreateMessageBrokerParams { 36 | dsgContext.serverDirectories.messageBrokerDirectory = join( 37 | dsgContext.serverDirectories.srcDirectory, 38 | "kafka" 39 | ); 40 | return eventParams; 41 | } 42 | ``` 43 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-package-json.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-package-json 3 | title: Create Package Json | Plugin Event 4 | description: Create the package.json file of the service. 5 | sidebar_label: Create Package Json 6 | slug: /plugins/plugin-events/create-package-json 7 | --- 8 | 9 | # Create Package Json 10 | 11 | ## Description 12 | 13 | Create the `package.json` file of the service. 14 | 15 | ## Event Params 16 | 17 | ```javascript 18 | export interface CreateServerPackageJsonParams extends EventParams { 19 | updateValues: { [key: string]: JsonValue }; 20 | } 21 | ``` 22 | 23 | ## Event Name 24 | 25 | `CreatePackageJson` 26 | 27 | ### updateValues 28 | 29 | TBC 30 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-seed.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-seed 3 | title: Create Seed | Plugin Event 4 | description: Creates the feed file. 5 | sidebar_label: Create Seed 6 | slug: /plugins/plugin-events/create-seed 7 | --- 8 | 9 | # Create Seed 10 | 11 | ## Description 12 | 13 | Creates the seed file. By default, this seed file contains only the seeding of the User entity. 14 | 15 | ## Event Name: 16 | 17 | `CreateSeed` 18 | 19 | ## Event Params 20 | 21 | ```ts 22 | export interface CreateSeedParams extends EventParams { 23 | template: namedTypes.File; 24 | templateMapping: { [key: string]: any }; 25 | fileDir: string; 26 | outputFileName: string; 27 | } 28 | ``` 29 | 30 | ### template 31 | 32 | A template file, used to generate the service. 33 | 34 | This is the default template that is used for this event: 35 | https://github.com/amplication/amplication/blob/master/packages/data-service-generator/src/server/seed/seed.template.ts 36 | 37 | You can manipulate the template or replace it completely with a new template in your plugin. 38 | 39 | ### templateMapping 40 | 41 | An object with values that are available in the interpolation process of the template. 42 | 43 | You can find the available properties here: 44 | https://github.com/amplication/amplication/blob/master/packages/data-service-generator/src/server/seed/create-seed.ts#L86 45 | 46 | You can manipulate the object by adding new values, or replacing existing values that will be used in the template when creating the seed file. 47 | 48 | ### fileDir 49 | 50 | The target directory in which the seed file will be generated. 51 | 52 | ### outputFileName 53 | 54 | The file name of the seed file. The default value is `seed.ts` 55 | 56 | It is recommended not to change the file name unless specifically required and the impact is understood. 57 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-server-dot-env.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server-dot-env 3 | title: Create Server dotenv | Plugin Event 4 | description: Creates the server's .env file. 5 | sidebar_label: Create Server dotenv 6 | slug: /plugins/plugin-events/create-server-dot-env 7 | --- 8 | 9 | # Create Server Dot Env 10 | 11 | ## Description 12 | 13 | Creates the server's `.env` file 14 | 15 | ## Event Name 16 | 17 | `CreateServerDotEnv` 18 | 19 | ## Event Params 20 | 21 | ```ts 22 | export interface CreateServerDotEnvParams extends EventParams { 23 | envVariables: VariableDictionary; 24 | } 25 | ``` 26 | 27 | ```ts 28 | export type VariableDictionary = { 29 | [variable: string]: string; 30 | }[]; 31 | ``` 32 | 33 | ### envVariables 34 | 35 | An Array of objects represents the key-value pairs the user wants to add to the generated `.env` file. 36 | 37 | **Example** 38 | 39 | ```ts 40 | export const envVariables: VariableDictionary = [ 41 | { DB_USER: "${dbUser}" }, 42 | { DB_PASSWORD: "${dbPassword}" }, 43 | { DB_PORT: "${dbPort}" }, 44 | { 45 | DB_URL: "mysql://${dbUser}:${dbPassword}@${dbHost}:${dbPort}${dbName}", 46 | }, 47 | ]; 48 | 49 | beforeCreateServerDotEnv( 50 | context: DsgContext, 51 | eventParams: CreateServerDotEnvParams 52 | ) { 53 | eventParams.envVariables = [...eventParams.envVariables, ...envVariables]; 54 | 55 | return eventParams; 56 | } 57 | ``` 58 | 59 | The values: `${dbUser}` , `${dbPassword}` , `${dbPort}`, `${dbHost}` , `${dbName}` are coming from: 60 | my-project => my-service => settings => database 61 | 62 | ![](./assets/dbsettings.png) 63 | 64 | As you can see in the screenshot, the only variable that doesn't have a default value is the `${dbName}`. 65 | When you install one of the DB plugins, the value of `${dbName}` is the service name. 66 | -------------------------------------------------------------------------------- /docs/plugins/plugin-events/create-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: create-server 3 | title: Create Server | Plugin Event 4 | sidebar_label: Create Server 5 | slug: /plugins/plugin-events/create-server 6 | --- 7 | 8 | # Create Server 9 | 10 | ## Description 11 | 12 | This event wraps the entire process of generation of the server-side code. 13 | 14 | ## Event Params 15 | 16 | ```javascript 17 | export interface PrepareContextParams extends EventParams {} 18 | ``` 19 | 20 | This event does not use any additional parameters. 21 | -------------------------------------------------------------------------------- /docs/plugins/plugindev-overview.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: overview 3 | title: Plugin Development Overview 4 | sidebar_label: Overview 5 | slug: /plugins/overview 6 | pagination_next: plugins/plugin-architecture 7 | pagination_prev: plugins/event-hierarchy 8 | --- 9 | 10 | # Plugin Development Overview 11 | 12 | A plugin is code that extends the Amplication developer platform by adding new features or modifying existing functionality. 13 | The features incorporated can be generic, useful to a wide variety of users, or can be very specific to deal with specialized requirements. 14 | 15 | If you or your organization have a specific workflow, install an existing plugin or write one to customize the platform to perform your required tasks. 16 | 17 | The plugin is published as an NPM package. It is then installed and executed as part of the code generation process to allow the plugin writer to manipulate and extend the default behavior. 18 | 19 | All published plugins are available on the **All Plugins** page on the Amplication interface. All plugins installed on a particular service are available in the **Installed Plugins** page. 20 | 21 | ![](.\assets\installed-plugins2.png) 22 | 23 | ## Using Plugins 24 | 25 | To understand how Plugins are installed and activated by the user, see [Using Plugins](/getting-started/plugins/) 26 | -------------------------------------------------------------------------------- /docs/premium-features/assets/break-the-monolith-ai-helper.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/break-the-monolith-ai-helper.png -------------------------------------------------------------------------------- /docs/premium-features/assets/break-the-monolith-confirm-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/break-the-monolith-confirm-architecture.png -------------------------------------------------------------------------------- /docs/premium-features/assets/break-the-monolith-overview-mode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/break-the-monolith-overview-mode.png -------------------------------------------------------------------------------- /docs/premium-features/assets/break-the-monolith-redesign-mode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/break-the-monolith-redesign-mode.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/action-graphql.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/action-graphql.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/action-input-output-types.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/action-input-output-types.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/action-name-and-description.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/action-name-and-description.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/action-rest.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/action-rest.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/add-module.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/add-module.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/all-actions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/all-actions.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/api-tab-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/api-tab-overview.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/create-action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/create-action.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/create-dto.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/create-dto.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/delete-module.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/delete-module.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/dto-name-and-description.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/dto-name-and-description.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/dto-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/dto-properties.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/edit-action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/edit-action.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/edit-disable-delete-dto.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/edit-disable-delete-dto.png -------------------------------------------------------------------------------- /docs/premium-features/assets/custom-types-and-actions/edit-module.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/custom-types-and-actions/edit-module.png -------------------------------------------------------------------------------- /docs/premium-features/assets/enterprise-sync-with-git-providers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/premium-features/assets/enterprise-sync-with-git-providers.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/amplication-auth-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/amplication-auth-flow.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/app-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/app-settings.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/bitbucket-oauth-consumer-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/bitbucket-oauth-consumer-permissions.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/bitbucket-oauth-consumer-privacy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/bitbucket-oauth-consumer-privacy.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/client-secret.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/client-secret.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/connect-to-bitbucket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/connect-to-bitbucket.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/grant-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/grant-access.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/register-new-bitbucket-oauth-consumer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/register-new-bitbucket-oauth-consumer.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/register-new-github-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/register-new-github-app.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/register-new-oauth-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/register-new-oauth-app.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/assets/select-workspace.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/running-amplication-platform/assets/select-workspace.png -------------------------------------------------------------------------------- /docs/running-amplication-platform/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Running Amplication Platform 3 | --- 4 | 5 | # Running Amplication Platform -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-001-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-001-001.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-001.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-002.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-002.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-003.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-003.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-004.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-004.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-005.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-005.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-006.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-006.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-007.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-007.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-008.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-008.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-009.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-009.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-010.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-010.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-011.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-011.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-012.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-012.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-013.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-013.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-014.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-014.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-015.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-015.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-016.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-016.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-002-017.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-002-017.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-003-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-003-001.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/assets/step-003-002.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/angular-todos/assets/step-003-002.png -------------------------------------------------------------------------------- /docs/tutorials/angular-todos/step-000.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: angular-todos-step-000 3 | title: Angular Todos 4 | sidebar_label: Getting Started 5 | slug: /tutorials/angular-todos 6 | --- 7 | 8 | # Angular Todos 9 | 10 | Welcome to this tutorial on how to build a full-stack application with Amplication. 11 | 12 | This guide assumes that you have, at minimum, a working understanding of the following: 13 | 14 | - [Angular](https://angular.io/) 15 | - [Node](https://nodejs.org/en) 16 | - [GitHub](https://github.com/) 17 | - An IDE 18 | 19 | As well as having, at minimum, a basic understanding of the following: 20 | 21 | - REST APIs 22 | - [GraphQL](https://graphql.org/) 23 | - [Docker](https://www.docker.com/) 24 | 25 | You'll also need an Amplication account, [visit here](https://app.amplication.com/login) to create one. 26 | 27 | What we will do is go step by step to create a `Todos` application using Angular for your frontend and Amplication for your backend. 28 | 29 | If you get stuck, have any questions, or just want to say hi to other Amplication developers like yourself, then you should join our [Discord](https://amplication.com/discord)! 30 | -------------------------------------------------------------------------------- /docs/tutorials/assets/amplication-youtube.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/assets/amplication-youtube.png -------------------------------------------------------------------------------- /docs/tutorials/community-tutorials.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Community Tutorials 3 | sidebar_label: Community Tutorials 4 | --- 5 | 6 | # Community Tutorials 7 | 8 | The Amplication community has created some great tutorials showing how to build different types of backends using Amplication. 9 | These tutorials demonstrate integrating Amplication with various frontends, databases, and other technologies. 10 | 11 | ## Tutorials 12 | 13 | - [Creating a Chatroom in Angular using Amplication](https://dev.to/akshitadixit/creating-a-chatroom-in-angular-using-amplication-39l) 14 | -[⚛️ Full Stack Amazon Clone with Next.js, Typescript, Tailwind CSS, Zustand, Next UI, Recharts and Amplication 🚀](https://dev.to/koolkishan/full-stack-amazon-clone-with-nextjs-typescript-tailwind-css-zustand-next-ui-recharts-and-amplication-1h89) 15 | - [Building Scalable Microservices with Amplication, GraphQL, MongoDB, and Kafka](https://dev.to/tyaga001/building-scalable-microservices-with-amplication-graphql-mongodb-and-kafka-1ee0) 16 | - [Creating a To-Do App in Flutter using Amplication](https://dev.to/hamdaanaliquatil/creating-a-to-do-app-in-flutter-using-amplication-2mem) 17 | - [How to deploy Amplication app to DigitalOcean](https://dev.to/thucpn/how-to-deploy-amplication-app-to-digitalocean-o3e) 18 | - [Building a Data-Heavy NodeJS App with Amplication](https://medium.com/faun/building-a-data-heavy-nodejs-app-with-amplication-2c82f44a912f) 19 | 20 | ## Add Your Tutorial 21 | 22 | If you've written a tutorial for building backends with Amplication, please consider adding it to the documentation. 23 | Just open a pull request adding your tutorial to this page. 24 | We'd love to share what the community is building with Amplication! -------------------------------------------------------------------------------- /docs/tutorials/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Introduction 3 | --- 4 | 5 | # Learn Amplication with Tutorials 6 | 7 | To help you get started and learn Amplication in-depth we've put together some real world, step-by-step tutorials. We also have other learning resources for you on our YouTube channel and blog. 8 | 9 | ## Step-by-step Tutorials 10 | 11 | We currently have two step-by-step tutorials that help you build apps with either Angular or React. 12 | 13 | - [Angular Todos](/tutorials/angular-todos/): Build a todos app with Angular as your front-end and Amplication as your backend. 14 | - [React Todos](/tutorials/react-todos/): Build a todos app with React as your front-end and Amplication as your backend. 15 | 16 | ## YouTube Developer Guides 17 | 18 | [![Image of Amplication's YouTube Channel](./assets/amplication-youtube.png)](https://www.youtube.com/c/Amplicationcom) 19 | 20 | If you prefer video, we have various developer guides on [our YouTube channel](https://www.youtube.com/c/Amplicationcom). 21 | 22 | These includes guides like [Guarding your routes in NestJS](https://www.youtube.com/watch?v=nEkB3k0bJWc), [plugging into MongoDB](https://www.youtube.com/watch?v=4DYo6oJN8N4), and others. 23 | 24 | ## Amplication's blog 25 | 26 | Finally, we also have various developer-focused posts up on [our blog](https://amplication.com/blog). -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-001-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-001-001.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-001.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-002.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-002.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-003.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-003.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-004.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-004.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-005.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-005.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-006.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-006.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-007.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-007.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-008.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-008.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-009.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-009.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-010.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-010.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-011.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-011.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-012.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-012.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-013.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-013.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-014.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-014.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-015.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-015.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-016.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-016.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-002-017.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-002-017.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-003-001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-003-001.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/assets/step-003-002.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amplication/docs/fb9b3d4e24bdf688279f704a128d1df997406784/docs/tutorials/react-todos/assets/step-003-002.png -------------------------------------------------------------------------------- /docs/tutorials/react-todos/step-000.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: react-todos-step-000 3 | title: React Todos 4 | sidebar_label: Getting Started 5 | slug: /tutorials/react-todos 6 | --- 7 | 8 | # React Todos 9 | 10 | Welcome to this tutorial on how to build a full-stack application with Amplication. 11 | 12 | This guide assumes that you have, at minimum, a working understanding of the following: 13 | 14 | - [React](https://reactjs.org/) 15 | - [Node](https://nodejs.org/en) 16 | - [GitHub](https://github.com/) 17 | - An IDE 18 | 19 | As well as having, at minimum, a basic understanding of the following: 20 | 21 | - REST APIs 22 | - [GraphQL](https://graphql.org/) 23 | - [Docker](https://www.docker.com/) 24 | 25 | You'll also need an Amplication account, [visit here](https://app.amplication.com/login) to create one. 26 | 27 | What we will do is go step by step to create a `Todos` application using React for your frontend and Amplication for your backend. 28 | 29 | If you get stuck, have any questions, or just want to say hi to other Amplication developers like yourself, then you should join our [Discord](https://amplication.com/discord)! 30 | -------------------------------------------------------------------------------- /netlify.toml: -------------------------------------------------------------------------------- 1 | [[redirects]] 2 | from = "/guides/getting-started" 3 | to = "/getting-started" 4 | status = 301 5 | 6 | [[redirects]] 7 | from = "/docs/how-to/dev-env" 8 | to = "/getting-started/dev-env" 9 | status = 301 10 | 11 | [[redirects]] 12 | from = "/connect-server-to-github" 13 | to = "/running-amplication-platform/connect-server-to-github/" 14 | status = 301 15 | 16 | [[redirects]] 17 | from = "/docs/*" 18 | to = "/:splat" 19 | status = 301 -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "docs-website", 3 | "version": "0.0.0", 4 | "private": true, 5 | "scripts": { 6 | "docusaurus": "docusaurus", 7 | "start": "docusaurus start", 8 | "build": "docusaurus build", 9 | "postbuild": "copyfiles -f \"./netlify.toml\" build", 10 | "swizzle": "docusaurus swizzle", 11 | "deploy": "docusaurus deploy", 12 | "clear": "docusaurus clear", 13 | "serve": "docusaurus serve", 14 | "cspell": "cspell \"**/*.{md,mdx}\" -c .github/workflows/cspell.json" 15 | }, 16 | "dependencies": { 17 | "@docusaurus/core": "^2.3.1", 18 | "@docusaurus/module-type-aliases": "^2.3.1", 19 | "@docusaurus/plugin-client-redirects": "^2.3.1", 20 | "@docusaurus/preset-classic": "^2.3.1", 21 | "@mdx-js/react": "^1.6.22", 22 | "clsx": "^1.2.1", 23 | "docusaurus-gtm-plugin": "^0.0.2", 24 | "npm": "^9.1.1", 25 | "prism-react-renderer": "^1.3.5", 26 | "react": "^17.0.2", 27 | "react-dom": "^17.0.2" 28 | }, 29 | "devDependencies": { 30 | "copyfiles": "^2.4.1", 31 | "cspell": "^6.30.2" 32 | }, 33 | "browserslist": { 34 | "production": [ 35 | ">0.5%", 36 | "not dead", 37 | "not op_mini all" 38 | ], 39 | "development": [ 40 | "last 1 chrome version", 41 | "last 1 firefox version", 42 | "last 1 safari version" 43 | ] 44 | }, 45 | "engines": { 46 | "node": ">=16.14" 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /plugins/analytics/analytics.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | onRouteDidUpdate({ location, previousLocation }) { 3 | if ( 4 | previousLocation && 5 | (location.pathname !== previousLocation.pathname || 6 | location.search !== previousLocation.search || 7 | location.hash !== previousLocation.hash) 8 | ) { 9 | //segment 10 | window.analytics?.page(location.pathname, { url: location.pathname }); 11 | // hubspot 12 | window._hsq?.push(["setPath", location.pathname]); 13 | window._hsq?.push(["trackPageView"]); 14 | } 15 | }, 16 | }; 17 | -------------------------------------------------------------------------------- /plugins/analytics/index.js: -------------------------------------------------------------------------------- 1 | module.exports = function () { 2 | return { 3 | name: "docusaurus-plugin-analytics", 4 | getClientModules() { 5 | return ["./analytics"]; 6 | }, 7 | }; 8 | }; 9 | -------------------------------------------------------------------------------- /src/theme/DocItem/Footer/Feedback/styles.module.css: -------------------------------------------------------------------------------- 1 | .feedback { 2 | background-color: var(--alert-secondary-background); 3 | border: 1px solid var(--alert-secondary-border-color); 4 | margin-bottom: 1em; 5 | margin-top: 1rem; 6 | border-radius: var(--ifm-alert-border-radius); 7 | box-shadow: var(--ifm-alert-shadow); 8 | color: var(--ifm-alert-foreground-color); 9 | padding: var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal); 10 | } 11 | 12 | .feedback input[type="radio"] { 13 | margin: 0 1rem 0 0; 14 | } 15 | 16 | .feedback .thank-you { 17 | text-align: center; 18 | } -------------------------------------------------------------------------------- /src/theme/DocItem/Footer/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import Footer from '@theme-original/DocItem/Footer'; 3 | import Feedback from './Feedback'; 4 | 5 | export default function FooterWrapper(props) { 6 | return ( 7 | <> 8 |