diff --git a/docs/faqs/faqs.md b/docs/faqs/faqs.md index 4c391816..908e7c16 100644 --- a/docs/faqs/faqs.md +++ b/docs/faqs/faqs.md @@ -12,7 +12,7 @@ Here are some questions that we are asked about frequently about using Amplicati ### What is Amplication? -Amplication is an open-source AI-powered code generation platform that helps developers build and manage backend services without spending time on repetitive coding tasks and boilerplate code. Amplication auto-generates a fully functional, production-ready backend based on Node.js and .NET. +Amplication is an open-source AI-powered code generation platform that helps developers build and manage backend services without spending time on repetitive coding tasks and boilerplate code. Our platform generates fully functional, production-ready backend services that follow modern best practices. ### How does Amplication work? @@ -57,7 +57,7 @@ Amplication offers a structured way to [add custom code](https://docs.amplicatio We also provide various [plugins](https://docs.amplication.com/getting-started/plugins/), like Prettier and ESLint, so you can format your code exactly how you need it. -Furthermore, you can create [private plugins](https://docs.amplication.com/enterprise-private-plugins/) that are accessible only within your organization. +Furthermore, you can create [private plugins](/private-plugins/) that are accessible only within your organization. ## Version Control and Collaboration diff --git a/docs/getting-started/first-service.md b/docs/getting-started/first-service.md index fc6a982d..804ae76c 100644 --- a/docs/getting-started/first-service.md +++ b/docs/getting-started/first-service.md @@ -6,18 +6,16 @@ sidebar_label: Create Your First Service slug: /first-service --- -# Create Your First Service With Amplication +# Create Your First Service -Amplication accelerates your app development by helping you build production-ready backends in either Node.js or .NET. These automatically-generated backends, known as **services**, utilize modern frameworks such as NestJS and Prisma for Node.js, and ASP.NET Core alongside Entity Framework Core for .NET. +Amplication accelerates your app development by helping you build production-ready backend services. These automatically-generated backends, known as **services**, provide modern, secure, and scalable foundations for your apps. -Each service includes both REST and GraphQL APIs and comes with an interactive React Admin UI. These services offer a comprehensive solution that encompasses authentication, authorization, logging, git synchronization, and other critical backend management functionalities. +Each service includes REST and GraphQL API support and an optional admin interface. Your service comes fully equipped with authentication, authorization, logging, git synchronization, and other critical backend management functionalities. -This guide will help you create your first service using our streamlined service creation onboarding wizard. +This guide will help you create your first service using our creation wizard. -:::tip -[Amplication's AI](/amplication-ai) can help you build your first service with a single request in a few seconds. - -Ask Jovu: `Can you create a new blog service with entities for posts, categories, authors, and comments?` +:::info Generated Service Example +Want to see an example of what a generated service looks like? Check out the [Generated Service Sample App](https://github.com/amplication/sample-app) on GitHub. ::: ## Prerequisites @@ -26,12 +24,32 @@ First, [sign up](https://app.amplication.com/login) for an Amplication account w ![](./assets/first-service/amplication-home-page.png) -If this is your first time using Amplication, the Service Creation Wizard start automatically will guide you through the process. +If this is your first time using Amplication, the Service Creation Wizard will automatically guide you through the process. ## Step 1: Name Your Service When naming your service, consider its primary function. What will it do? What problem is it solving? An appropriately named service will be easier to identify and maintain. +
+Available Technology Stacks + +Amplication supports two technology stacks for your backend services: + +**Node.js** +- NestJS framework +- Prisma ORM +- GraphQL and REST APIs +- React Admin UI + +**.NET** + +- ASP.NET Core +- Entity Framework Core +- REST APIs + +Choose the stack that best fits your team's expertise and project requirements during service creation. +
+ ![](./assets/first-service/service-name.png) ## Step 2: Connect Your GitHub Repository @@ -47,7 +65,7 @@ You can also create a new repository by clicking on the **Create repository** bu ![](./assets/first-service/select-repository.png) -:::note +:::note Other Supported Git Providers In addition to GitHub, Amplication also supports [Bitbucket](/sync-with-bitbucket) and [AWS CodeCommit](/sync-with-aws-codecommit) for Enterprise users. ::: @@ -87,7 +105,7 @@ Monorepo is recommended if you plan on having multiple services in a single GitH Amplication supports PostgreSQL, MongoDB, and MySQL out of the box. Choose the one that suits your needs. :::tip -You're not locked into your choice - you can always change your database type later in your project's plugin page. +You're not locked into your choice - you can always [change your database type later](/plugins/guides/database/) in your project's plugin page. ::: ![](./assets/first-service/database.png) @@ -96,7 +114,7 @@ You're not locked into your choice - you can always change your database type la Define entities and fields for your database. You can manually define your own or use a set of pre-defined entities provided by Amplication. -:::info +:::info What Are Entities? Entities are the objects you want to keep track of in your app, like a User or a Product. They become tables in your database. Each row represents an instance of the entity. A field is a column in that table that represents an attribute of that entity. @@ -118,12 +136,6 @@ Congratulations! You've successfully set up your first service on Amplication. Y Clicking on the `View my code` button will take you to the GitHub repository you chose in Step 2. Specifically, you'll see Amplication's first commit to that repository. -:::note -If you're curious about what the generated code for a service looks like, we have an example on GitHub for you. Check out the following repository: - -[Amplication Generated Service Sample App](https://github.com/amplication/sample-app) -::: - ![](./assets/first-service/service-created-successfully.png) ## Next Steps diff --git a/docs/getting-started/generated-app.md b/docs/getting-started/generated-app.md index 40aae2e9..f0000883 100644 --- a/docs/getting-started/generated-app.md +++ b/docs/getting-started/generated-app.md @@ -11,20 +11,22 @@ When you use Amplication to create your backend service, we automatically genera Some of the key features of our generated backend services include: -- **Extensive Functionality**: The generated services provide a wide range of features, including authentication, authorization, data validation, logging, a database, and a REST API. For Node.js services, they also offer GraphQL APIs for efficient data communication and a React-based admin UI. -- **Clean Architecture**: Both Node.js and .NET services are structured following the clean architecture principles, ensuring that the business logic is decoupled from the infrastructure and UI layers. This makes the code easier to maintain and test. -- **Ready for Production**: The generated services are optimized for [deployment](/deploy/), include Docker configurations and CI/CD pipelines, making it straightforward to move from development to production. -- **Customizable and Extendable**: While the service provides a solid foundation, it is fully customizable. Developers can extend the generated code with custom features and integrate additional services as needed. - -:::note -You can see an example of a Node.js service generated with Amplication in this [GitHub repository](https://github.com/amplication/sample-app). +- **Comprehensive APIs**: Every service includes REST APIs with built-in validation, documentation, and testing capabilities. Optional GraphQL support is available for enhanced data querying. +- **Authentication & Authorization**: Built-in user management, role-based access control, and security best practices. +- **Database Integration**: Robust database connectivity with your choice of modern ORMs and data validation. +- **Developer Experience**: Generated services include logging, testing frameworks, and development tools configured according to industry standards. +- **Production-ready**: Includes Docker configurations and CI/CD pipelines for straightforward deployment to your preferred platform. +- **Extensible Architecture**: Clean, modular architecture that separates business logic from infrastructure concerns, making the code easy to maintain and customize. + +:::info Generated Service Example +See an example of a generated service in our [sample application repository](https://github.com/amplication/sample-app). ::: ## Technologies The generated services utilize a suite of proven, robust technologies tailored for each supported technology. -Below are the technologies employed for Node.js and .NET, ensuring efficient, reliable, and scalable server-side applications. +Below are the technologies used for Amplication's supported tech stacks, ensuring efficient, reliable, and scalable server-side apps. ### Server-side diff --git a/docs/getting-started/plugins.md b/docs/getting-started/plugins.md index 801911a0..afa27842 100644 --- a/docs/getting-started/plugins.md +++ b/docs/getting-started/plugins.md @@ -23,11 +23,11 @@ If you choose to turn on authentication for your service, that will enable Authe Ask Jovu: `Which plugins do you recommend for adding caching capabilities to my Amplication service?` ::: -## Node.js and .NET Plugins +## Available Plugins Amplication supports both Node.js and .NET for code generation. Plugins are technology-specific. -When you switch between Node.js and .NET, you'll see a different set of available plugins, each optimized for the chosen stack. +Node.js and .NET services will see a different set of available plugins, each optimized for the chosen stack. Node.js plugins integrate seamlessly with the Node.js ecosystem and popular frameworks like NestJS. .NET plugins are designed to work with .NET Core and leverage the power of the .NET ecosystem. diff --git a/docs/how-to/authentication-plugin-examples.mdx b/docs/how-to/authentication-plugin-examples.mdx index 17c49d4f..1863a55b 100644 --- a/docs/how-to/authentication-plugin-examples.mdx +++ b/docs/how-to/authentication-plugin-examples.mdx @@ -7,29 +7,12 @@ pagination_next: getting-started/authentication # Authentication Plugin Guide -Authentication and authorization are crucial components of your Amplication service. +Authentication and authorization are crucial components of your Amplication service. This guide will help you implement secure user authentication using Amplication's authentication plugins. -By following this guide and exploring the examples, you'll be well-equipped to implement authentication and authorization in your Amplication-generated service using the authentication plugin that best suits your needs. +## Enable Authentication -## Creating The Authentication Entity (Node.js) - -:::note -This step is required only for Node.js services. .NET services do not require this step. -::: - -If you initially created your Node.js service without authentication, you must first create and define the Authentication Entity: - -1. Go to your service's Entities page. -2. Create an entity, typically named "User", to serve as your Authentication Entity. -3. In your service's settings, choose the newly created entity in the "Authentication Entity" option. - -:::tip -For detailed instructions, refer to the [Authentication Entity documentation](https://docs.amplication.com/user-entity). -::: - -## Adding Authentication to Your Service - -Once you have an Authentication Entity set up, follow these steps to add authentication: +Make sure you have an [Authentication Entity](/user-entity) set up. +Next, follow these steps to add authentication: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -42,6 +25,10 @@ import TabItem from '@theme/TabItem'; 3. Ensure you install the "NestJS Auth Module" plugin first. 4. Choose and add an Auth Provider plugin that suits your needs (e.g., Auth0, Supertokens, etc.). +:::note +By default, Node.js services are created with a user with the credentials username: `admin` and password: `admin`. +::: + @@ -49,24 +36,26 @@ import TabItem from '@theme/TabItem'; 2. Go to the "Authentication" category in the left sidebar. 3. Choose and add an Auth Provider plugin that suits your needs (e.g., ASP.NET Core Identity). +:::note +For .NET services, the default user credentials are username: `test@email.com` and password: `P@ssw0rd!` +::: + -After adding the required Authentication plugins: +After adding the required Authentication plugins, [configure your authentication settings](#plugin-configuration-settings) in the plugin options page. -1. [Configure your authentication settings](#authentication-plugin-configuration-settings) in the plugin options page. -2. Add authenticated users to your system. -3. [Set up roles and permissions](/configure-roles-and-permissions/) for authorization. +## Disable Authentication -:::note -By default, Node.js services are created with a user with the credentials username: `admin` and password: `admin`. For .NET services, the default user credentials are username: `test@email.com` and password: `P@ssw0rd!` -::: +If you no longer need authentication on a specific service, you can disable it. -## Available Authentication Plugins +1. Visit your service's Plugins page and toggle the Authentication-related plugins into the off state. +2. Delete the [Authentication Entity](/user-entity/) from your list of entities. +3. [Re-build your project](/building-new-versions/) and commit your changes to your preferred git provider. -Amplication offers several authentication plugins to choose from. Each plugin has its own configuration options and setup process. +## Authentication Providers -### Node.js +Amplication supports multiple authentication providers to suit different needs: 1. [JWT Auth Provider](https://jwt.io/) 2. [Auth0 Auth Provider](https://auth0.com/) @@ -74,33 +63,34 @@ Amplication offers several authentication plugins to choose from. Each plugin ha 4. [SAML Auth Provider](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language) 5. Basic Auth Provider 6. [KeyCloak Auth Provider](https://www.keycloak.org/) +7. [ASP.NET Core Identity](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/identity?view=aspnetcore-9.0&tabs=visual-studio) -#### JWT Auth Provider +### JWT Auth Provider - Adds JSON Web Token (JWT) authentication and authorization to your service. - Must be installed with the "NestJS Auth Module" plugin. - For detailed configuration, visit the [JWT Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-jwt). -#### Auth0 Auth Provider +### Auth0 Auth Provider - Integrates Auth0 authentication and authorization into your service. - Requires an Auth0 account and configuration of an Auth0 application. - For setup instructions and configuration options, check the [Auth0 Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-auth0). -#### Supertokens Auth Provider +### Supertokens Auth Provider - Adds Supertokens authentication to your service. - Supports various authentication recipes (e.g., email-password, passwordless, third-party). - Requires setup of the Supertokens core service. - For detailed configuration and usage, refer to the [Supertokens Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-supertokens). -#### SAML Auth Provider +### SAML Auth Provider - Enables SAML authentication on your service. - Uses Passport SAML strategy and generates JWT tokens for authorization. - For usage details, check the [SAML Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-saml). -#### Basic Auth Provider +### Basic Auth Provider - Enables a straightforward authentication scheme built into the HTTP protocol. - Requires sending user's credentials in the form of a username and password, encoded in base64, included in the Authorization header of the request. @@ -109,28 +99,24 @@ Amplication offers several authentication plugins to choose from. Each plugin ha If you use the Basic Auth Provider plugin, your service comes with one user with the username `admin` and the password `admin` by default. ::: -#### KeyCloak Auth Provider +### KeyCloak Auth Provider - Integrates KeyCloak authentication and authorization into your service. - Provides single sign-on (SSO) capabilities and support for various identity protocols. - Requires setup of a KeyCloak server and configuration of a KeyCloak realm. - For detailed setup instructions and configuration options, refer to the [KeyCloak Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-keycloak). -### .NET - -For .NET services, ASP.NET Core Identity is the primary authentication option. - -#### ASP.NET Core Identity +### ASP.NET Core Identity If you're using a .NET service, refer to the [.NET Auth Core Identity plugin documentation](https://github.com/amplication/plugins/tree/master/plugins/dotnet-auth-core-identity) for setup and usage instructions. -## Authentication Plugin Configuration Settings +## Plugin Configuration Settings You can customize your authentication settings, including the default username and password, in the authentication plugin's options page. Let's look at detailed configuration settings for some of the available authentication plugins: -### ASP.NET Core Identity (.NET) +### ASP.NET Core Identity This plugin adds authentication and authorization to your .NET services. @@ -146,7 +132,7 @@ This plugin adds authentication and authorization to your .NET services. - `seedUserEmail`: The email address for the default seed user created when initializing the service (default: "test@email.com") - `seedUserPassword`: The password for the default seed user created when initializing the service (default: "P@ssw0rd!") -### JWT Auth Provider (Node.js) +### JWT Auth Provider The JWT Auth Provider adds JSON Web Token (JWT) authentication and authorization to your service. @@ -170,7 +156,7 @@ The JWT Auth Provider adds JSON Web Token (JWT) authentication and authorization For detailed configuration, visit the [JWT Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-jwt). -### Auth0 Auth Provider (Node.js) +### Auth0 Auth Provider The Auth0 Auth Provider integrates Auth0 authentication and authorization into your service. @@ -203,7 +189,7 @@ The Auth0 Auth Provider integrates Auth0 authentication and authorization into y For setup instructions and configuration options, check the [Auth0 Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-auth0). -### Supertokens Auth Provider (Node.js) +### Supertokens Auth Provider The Supertokens Auth Provider adds Supertokens authentication to your service, supporting various authentication recipes. @@ -239,7 +225,7 @@ The Supertokens Auth Provider adds Supertokens authentication to your service, s For detailed configuration and usage, refer to the [Supertokens Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-supertokens). -### Keycloak Auth Provider (Node.js) +### Keycloak Auth Provider The Keycloak Auth Provider integrates Keycloak authentication and authorization into your service. @@ -280,7 +266,7 @@ The Keycloak Auth Provider integrates Keycloak authentication and authorization For detailed setup instructions and configuration options, refer to the [Keycloak Auth Provider GitHub README](https://github.com/amplication/plugins/tree/master/plugins/auth-keycloak). -### Basic Auth Provider (Node.js) +### Basic Auth Provider ```json { @@ -292,19 +278,11 @@ For detailed setup instructions and configuration options, refer to the [Keycloa - `username`: The username for the default seed user created when initializing the service. - `seedUserPassword`: The password for the default seed user created when initializing the service. -## Disable Authentication On Your Service - -If you no longer need authentication on a specific service, you can disable it. - -1. Visit your service's Plugins page and toggle the Authentication-related plugins into the off state. -2. Delete the Authentication Entity from your list of entities. -3. Re-build your project and commit your changes to your preferred git provider. - ## Examples This section provides you with in-depth examples on how to use and interact with some of the available authentication plugins. -### JWT Authentication (Node.js) +### JWT Authentication When generating an app with JWT authentication, the process includes the following two steps: @@ -348,7 +326,7 @@ mutation { -### Basic Authentication (Node.js) +### Basic Authentication When using Basic HTTP authentication and sending a request to the API you must provide a Basic HTTP authentication header with the format: @@ -363,3 +341,10 @@ Authorization: Basic YWRtaW46YWRtaW4= :::tip You can use a tool to create the header. There are several generators available, such as [https://www.blitter.se/utils/basic-authentication-header-generator/](https://www.blitter.se/utils/basic-authentication-header-generator/) ::: + +## Next Steps + +After you've successfully added authentication to your service, you can do the following: + +1. Add authenticated users to your system. +2. [Set up roles and permissions](/configure-roles-and-permissions/) for authorization. diff --git a/docs/how-to/deploy.md b/docs/how-to/deploy.md index 50e5e3c3..80ec1b82 100644 --- a/docs/how-to/deploy.md +++ b/docs/how-to/deploy.md @@ -8,24 +8,27 @@ slug: /deploy # Amplication Deployment Amplication provides flexible and powerful deployment options for services generated using our platform. -This guide provides an overview of Amplication's deployment options and links to specific instructions for various deployment targets. +This guide provides an overview of deployment options and links to specific instructions for various deployment targets. ## Understanding Amplication's Deployment Architecture -Amplication services are composed of at least two main parts, all of which are automatically generated by our platform. +Every Amplication service consists of core components that work together to deliver your application: -1. **API Server** -2. **Database** +### Core Components -Depending on your service requirements, Amplication can automatically generate the code for additional components such as: +1. **API Server**: Your main application server +2. **Database**: Persistent data storage -- Message brokers like Kafka -- Caching solutions like Redis -- Other integrations specific to your service needs +### Optional Components -These additional components are seamlessly integrated as containers in your `docker-compose` file. +Depending on your service requirements, you may include: -All components, including optional ones, are auto-generated by Amplication. +- Admin Interface (Pre-built administrative dashboard) +- Message brokers (e.g., Kafka, RabbitMQ) +- Caching solutions (e.g., Redis) +- Other plugins + +All components are containerized and defined in your generated `docker-compose` file, making deployment consistent across environments. ## Deployment Options diff --git a/docs/how-to/service-catalog.md b/docs/how-to/service-catalog.md index 72bbc70f..984d47c2 100644 --- a/docs/how-to/service-catalog.md +++ b/docs/how-to/service-catalog.md @@ -17,7 +17,7 @@ The grid displays comprehensive information about each service through the follo - **Type** - Displays the resource type with visual indicators: purple brackets icon for services, green icon for message brokers, and distinct icons for other resource types - **Name** - The name of your service - **Owner** - Shows the assigned team or individual member responsible for the service. Clicking this field takes you to settings where you can modify ownership -- **Code Generator** - Indicates whether the service uses Node.js or .NET +- **Code Generator** - Indicates the selected technology stack for the service - **Repository** - Shows the connected Git repository. Can be modified through the service's "Sync with Git" tab - **Description** - Custom description of your service, editable through the service settings - **Pending Changes** - Displays the number of uncommitted changes since the last build diff --git a/docs/platform-features/assets/alert-properties.png b/docs/platform-features/assets/alert-properties.png new file mode 100644 index 00000000..033f090f Binary files /dev/null and b/docs/platform-features/assets/alert-properties.png differ diff --git a/docs/platform-features/assets/alert-settings.png b/docs/platform-features/assets/alert-settings.png new file mode 100644 index 00000000..3e40865b Binary files /dev/null and b/docs/platform-features/assets/alert-settings.png differ diff --git a/docs/platform-features/assets/alert-types.png b/docs/platform-features/assets/alert-types.png new file mode 100644 index 00000000..33f5e702 Binary files /dev/null and b/docs/platform-features/assets/alert-types.png differ diff --git a/docs/platform-features/assets/resolve-technical-debt.png b/docs/platform-features/assets/resolve-technical-debt.png new file mode 100644 index 00000000..00c81223 Binary files /dev/null and b/docs/platform-features/assets/resolve-technical-debt.png differ diff --git a/docs/platform-features/assets/service-level-technical-debt.png b/docs/platform-features/assets/service-level-technical-debt.png new file mode 100644 index 00000000..cbc50d65 Binary files /dev/null and b/docs/platform-features/assets/service-level-technical-debt.png differ diff --git a/docs/platform-features/assets/technical-debt-grid.png b/docs/platform-features/assets/technical-debt-grid.png new file mode 100644 index 00000000..4258ee47 Binary files /dev/null and b/docs/platform-features/assets/technical-debt-grid.png differ diff --git a/docs/platform-features/technical-debt-management.md b/docs/platform-features/technical-debt-management.md new file mode 100644 index 00000000..de5efbf6 --- /dev/null +++ b/docs/platform-features/technical-debt-management.md @@ -0,0 +1,120 @@ +--- +id: technical-debt-management +title: Technical Debt Management +sidebar_label: Technical Debt Management +description: Comprehensive guide to managing technical debt in Amplication +--- + +# Technical Debt Management + +Amplication's Technical Debt Management system helps you maintain alignment between your services and organizational standards as they evolve. This feature provides automated alerts, easy updates, and comprehensive tracking to ensure your services stay current with the latest templates, plugins, and best practices. + +![Technical Debt Management Tab](./assets/technical-debt-grid.png) + +## Key Features + +- **Automated Technical Debt Detection**: Receive alerts when services, templates, or plugins become outdated +- **Centralized Management**: Track and resolve technical debt across all services from a single dashboard +- **Git Sync Integration**: Automated pull request generation for updates using [Smart Git Sync](/smart-git-sync/). +- **Flexible Resolution Options**: Choose when and how to address technical debt +- **Notification System**: Stay informed through in-app and email notifications + +## Accessing Technical Debt Management + +1. Navigate to the Platform Console by clicking "Platform" in the top left corner +2. Select the "Tech Debt" tab + +## Understanding Technical Debt Alerts + +### Alert Types + +Amplication tracks three primary categories of technical debt: + +1. **Template Alerts**: Notify when a service needs updating to match new template versions +2. **Plugin Alerts**: Indicate when plugin updates are available or when plugins require attention +3. **Amplication Code Engine Alerts**: Signal updates to Amplication's code generation engine + +![Technical Debt Alert Types](./assets/alert-types.png) + +### Alert Properties + +Each alert contains essential information: +- **Alert Type**: Specifies whether the alert is related to templates, plugins, or the code engine +- **Affected Resource**: Identifies the specific service or template that requires attention +- **Current Version in Use**: The version of the template, plugin, or code engine currently being used +- **Latest Available Version**: The most recent version available for update +- **Alert Creation Date**: The date when the system identified the technical debt +- **Alert Status**: Current state of the alert (Active, Resolved, Ignored, or Canceled) + +![Technical Alert Properties](./assets/alert-properties.png) + +## Managing Technical Debt + +### Viewing Alerts + +The Technical Debt dashboard provides a comprehensive view of all alerts: + +1. **Status Filter**: Filter alerts by: + - Active (default view) + - Resolved + - Ignored + - Canceled + +2. **Type Filter**: Filter by: + - Template alerts + - Plugin alerts + - Code Engine alerts + +## Resolving Technical Debt + +### Template Updates + +1. Click "View Details" on a template alert +2. Review the changes between versions in the diff view +3. Click "Upgrade" to accept the changes +4. Confirm the upgrade in the modal dialog + +:::note +After upgrading, changes become pending changes. Generate code to create individual PRs for the updates using the code generation workflow. +::: + +![Resolve Technical Debt on the Service-level](./assets/resolve-technical-debt.png) + +### Plugin Updates + +For services using "latest" version: +1. Click "View Details" on the plugin alert +2. The plugin will automatically update on the next code generation + +For services using pinned versions: +1. Click "View Details" +2. Generate code to apply changes + + +## Notification Settings + +Customize how you receive technical debt alerts: + +1. Click the bell icon in the upper right corner +2. Scroll to "Technical Debt Alert" settings +3. Configure preferences for: + - In-app notifications + - Email notifications + +![Technical Debt Alert Settings](./assets/alert-settings.png) + +## Integration with Development Workflow + +Technical debt management integrates seamlessly with your development process: + +1. **Alert Detection**: Amplication automatically detects when services drift from standards +2. **Review Process**: Team members can review and approve updates +3. **Code Generation**: Updates are applied through your normal code generation workflow +4. **Git Workflow**: Changes are managed through your existing Git workflow + +## Related Resources + +If you need additional support, please contact Amplication support team for assistance. + +- [Live Templates](/live-service-templates/) +- [Private Plugins](/private-plugins/) \ No newline at end of file diff --git a/docs/tutorials/react-todos/step-002.md b/docs/tutorials/react-todos/step-002.md index cc2136d9..aabbe567 100644 --- a/docs/tutorials/react-todos/step-002.md +++ b/docs/tutorials/react-todos/step-002.md @@ -188,20 +188,25 @@ Make sure that you replace `first-service` with the name of the service that you By doing this the Todo app UI will now run on port `5000` during development so it won't conflict with Amplication's default port for the server (which is `3000`). - We've also set the start to script to run our frontend and backend code at the same time. + We've also set the `start` script to run our frontend and backend code at the same time. -5. Before starting the server there are a few additional steps required. Read `server/README.md` for directions to: +6. Before starting the server there are a few additional steps required. Read `server/README.md` for directions to: - Create a Prisma client - Start a database in Docker - Initiate the database -6. When those steps have been completed run the following command: +7. When those steps have been completed run the following command: ```bash npm run start ``` +> **Note:** If you encounter an error indicating that port `5000` is already in use, it means another software may be using the port, causing a conflict. This issue can be resolved by changing the port used for the frontend in `package.json`. Update the start script for the frontend to use a different port, for instance: +> ```json +> "start:frontend": "cross-env PORT=5001 npm --prefix web start", +> ``` + ## Step 8 - Wrap Up The frontend of the Todo app will be running at [http://localhost:5000/](http://localhost:5000/), and the backend will be running at [http://localhost:3000/](http://localhost:3000/). diff --git a/docs/welcome.md b/docs/welcome.md index 872a0e10..eeeab1b9 100644 --- a/docs/welcome.md +++ b/docs/welcome.md @@ -10,11 +10,11 @@ slug: / Amplication helps you scaffold, build, maintain, and scale backend services that align with your organization's best practices, supporting you throughout the entire development process. -Our platform combines live templates, AI-powered code generation, and proactive technical debt management to help teams quickly scaffold, create, maintain, and scale production-ready Node.js and .NET backend services while continuously enforcing organizational standards. +Our platform combines live templates, AI-powered code generation, and proactive technical debt management to help teams quickly scaffold, create, maintain, and scale production-ready backend services while continuously enforcing organizational standards. ## Quickstart -[Create your first service](/first-service/) with Amplication's AI, Jovu, and generate a .NET or Node.js _production-ready codebase in minutes_. +[Create your first service](/first-service/) with Amplication's AI, Jovu, and generate a _production-ready codebase in minutes_. ## Embed Your Organization's Best Practices @@ -36,7 +36,7 @@ Maintain consistent standards across your entire service portfolio, with all cha Our AI assistant, Jovu, helps you rapidly generate production-ready backend services with built-in best practices. Generate complete service infrastructure including REST and GraphQL APIs, database models, authentication, and logging in minutes. Customize your services through our platform's intuitive interface while maintaining consistent standards. -- **[Jovu](/amplication-ai/)**: Generate production-ready .NET or Node.js code, get intelligent suggestions for your service's architecture, and more with Amplication AI. +- **[Jovu](/amplication-ai/)**: Generate production-ready code, get intelligent suggestions for your service's architecture, and more with Amplication AI. - **[Full Stack Code Generation](/getting-started/)**: Fully-functional REST and GraphQL APIs, database models, authentication, logging, React Admin UI, and more. - [Set up Entities and Fields](/set-up-entities) - [Configure API Endpoints](/custom-types-and-actions) diff --git a/docusaurus.config.js b/docusaurus.config.js index a9513f92..de17c320 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,6 +8,9 @@ module.exports = { organizationName: "amplication", // Usually your GitHub org/user name. projectName: "amplication", // Usually your repo name. trailingSlash: true, + stylesheets: [ + "https://fonts.googleapis.com/css?family=Poppins" + ], themeConfig: { metadata: [ { name: "twitter:card", content: "summary_large_image" }, @@ -177,6 +180,7 @@ module.exports = { editUrl: "https://github.com/amplication/docs/edit/main/", showLastUpdateAuthor: true, showLastUpdateTime: true, + breadcrumbs: false }, blog: false, theme: { diff --git a/sidebars.js b/sidebars.js index c4d1b0d9..904088eb 100644 --- a/sidebars.js +++ b/sidebars.js @@ -23,6 +23,7 @@ const sidebars = { "how-to/platform-console", "how-to/service-catalog", "how-to/live-service-templates", + "platform-features/technical-debt-management", { type: "doc", id: "plugins/private-plugins", @@ -262,7 +263,7 @@ const sidebars = { }, { type: "category", - label: "Learn", + label: "Tutorials", link: { type: "doc", id: "tutorials/index", @@ -329,19 +330,20 @@ const sidebars = { } ], }, - { - type: "category", - label: "About", - link: { - type: "doc", - id: "about/index", - }, - items: [ - "about/licensing", - "about/product-roadmap", - "getting-started/phone-home", - ], - }, + + // { + // type: "category", + // label: "About", + // link: { + // type: "doc", + // id: "about/index", + // }, + // items: [ + // "about/licensing", + // "about/product-roadmap", + // "getting-started/phone-home", + // ], + // }, "faqs/faqs", @@ -385,7 +387,7 @@ const sidebars = { }, { type: "category", - label: "Contribute To Amplication", + label: "Contribute", link: { type: "doc", id: "contributing", diff --git a/src/css/custom.css b/src/css/custom.css index 720732e6..62962b24 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -222,3 +222,115 @@ article > header { display: none; } } + +.menu__link { + color: #B7BAC7; + font-size: 14px; +} + +.menu__link.menu__link--active, +.menu__link.menu__link--sublist.menu__link--active { + color: #FFF; +} + +.markdown a, .markdown a:hover { + color: #53DBEE; +} + +.navbar__link:hover, .navbar__link--active { + color: #53DBEE; +} + +.markdown .alert a { + text-decoration-color: #53DBEE; +} + +.theme-edit-this-page { + color: #53DBEE; +} + +.pagination-nav__link:hover { + border-color: #53DBEE; +} + +.pagination-nav__label { + color: #53DBEE; +} + +.navbar__link { + font-size: 14px; +} + +.navbar__logo img { + height: 82%; +} + +@media only screen and (max-width: 995px) { + .navbar__logo img { + height: 90%; + } +} + +.table-of-contents__link { + color: #B7BAC7; + font-size: 12px; +} + +.table-of-contents__link.toc-highlight.table-of-contents__link--active, +.table-of-contents__link:hover { + color: #FFF; +} + +.breadcrumbs__link > svg > path { + fill: #B7BAC7; +} + +.markdown h1:first-child { + font-size: 32px; + font-weight: 600; + line-height: 1.25rem; + margin-top: 1rem; +} + +.markdown > h2 { + font-size: 18px; + font-weight: 600; + line-height: 1.25rem; +} + +.markdown > pre, +.markdown > ul, +.markdown > ol, +.markdown > p { + color: #D3D4DC; + font-size: 14px; + line-height: 1.25rem; +} + +.markdown .theme-admonition { + font-size: 14px; +} + +.markdown .theme-admonition a { + text-decoration: none; +} + +.markdown .theme-admonition a:hover { + text-decoration: underline; +} + +.menu__link--sublist-caret:after { + background: var(--ifm-menu-link-sublist-icon) 50% / 1.5rem 1.5rem +} + +.menu__caret:before { + background: var(--ifm-menu-link-sublist-icon) 50% / 1.5rem 1.5rem +} + +.menu::-webkit-scrollbar-track { + background-color: #15192C; +} + +.menu::-webkit-scrollbar-thumb { + background-color: #373D57; +}