Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit 80e938c

Browse files
authored
Merge branch 'main' into docs/authentication-entity-net-updates
2 parents 572d36a + 31c1e6d commit 80e938c

File tree

124 files changed

+6007
-292
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+6007
-292
lines changed

docs/custom-code/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Customize Your Application
44

55
# Customize Your Application
66

7-
Amplication enables you to generate code, manage custom files, and seed databases. We'll give you a brief overview what what Amplication can do in this area.
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.
88

99
## Custom Code with Amplication
1010

docs/dictionary/en-custom.txt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,14 @@ Zustand
9696
Supertokens
9797
Bitwarden
9898
Jovu
99-
Jovu's
99+
Jovu's
100+
passwordless
101+
Appsettings
102+
appsettings
103+
Codespaces
104+
Keycloak
105+
thirdparty
106+
emailpassword
107+
placeholder
108+
Quickstart
109+
autoupdating

docs/faqs/faqs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Here are some questions that we are asked about frequently about using Amplicati
1212

1313
### What is Amplication?
1414

15-
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.
15+
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.
1616

1717
### How does Amplication work?
1818

@@ -57,7 +57,7 @@ Amplication offers a structured way to [add custom code](https://docs.amplicatio
5757

5858
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.
5959

60-
Furthermore, you can create [private plugins](https://docs.amplication.com/enterprise-private-plugins/) that are accessible only within your organization.
60+
Furthermore, you can create [private plugins](/private-plugins/) that are accessible only within your organization.
6161

6262
## Version Control and Collaboration
6363

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_label: Example Services
3+
---
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_label: Intro to Amplication
3+
---

docs/getting-started-v2/quickstart.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_label: Quickstart
3+
---
258 KB
Loading

docs/getting-started/community-plugins.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Community Plugins
3-
sidebar_label: Plugins List
2+
title: Node.js Plugins
3+
sidebar_label: Node.js Plugins
44
slug: /plugins-list
55
pagination_next: plugins/overview
66
pagination_prev: getting-started/plugins
77
---
88

9-
# Amplication Community Plugins
9+
# Amplication Node.js Plugins
1010

11-
The following plugins are currently available.
11+
The following plugins are currently available for Node.js services generated by Amplication.
1212
Additional plugins will be added in future releases of Amplication.
1313

1414
:::note
15-
For the most updated list of plugins, it's recommended to check the _All Plugins_ page on your Amplication dashboard.
15+
For the most updated list of Node.js plugins, please check the _Plugins_ tab on your Amplication dashboard.
1616
:::
1717

1818
### Mongo DB
@@ -85,21 +85,15 @@ Integrate Auth0's robust authentication solutions into your service with the [Au
8585
[ESLint](https://github.com/amplication/plugins/tree/master/plugins/linter-eslint) is a library that helps find issues and enforce code style in your JavaScript code.
8686
ESLint has a wide array of rules that can be configured to enforce code quality and consistency.
8787

88-
### Redis
88+
### Redis Caching
8989

90-
[Redis](https://github.com/amplication/plugins/tree/master/plugins/cache-redis) is an open-source, in-memory data store that can be used as a database, cache, streaming engine, and message broker.
91-
Redis provides high availability via replication and high performance via caching.
92-
It is commonly used to quickly access frequently used application data.
90+
Enhance your application's performance with the [Redis Caching](https://github.com/amplication/plugins/tree/master/plugins/cache-redis) plugin. Redis is known for its fast data retrieval capabilities, making it an excellent choice for implementing caching strategies.
9391

9492
### Redis Message Broker
9593

9694
[Redis Message Broker](https://github.com/amplication/plugins/tree/master/plugins/broker-redis) is an extension of the traditional Redis in-memory data store, allowing it to function as a message broker.
9795
Install this plugin to leverage Redis's in-memory capabilities and enables asynchronous message communication between different parts of an application or between different applications.
9896

99-
### Redis Caching
100-
101-
Enhance your application's performance with the [Redis Caching](https://github.com/amplication/plugins/tree/master/plugins/cache-redis) plugin. Redis is known for its fast data retrieval capabilities, making it an excellent choice for implementing caching strategies.
102-
10397
### OpenAI
10498

10599
The [OpenAI](https://github.com/amplication/plugins/tree/master/plugins/integration-openai) plugin allows you to integrate OpenAI's various AI models into your Amplication app.
@@ -195,8 +189,30 @@ Incorporate Hashicorp Vault's powerful secrets management capabilities with the
195189

196190
### JSON Logger
197191

198-
The JSON Logger Plugin is designed for logging in JSON format. It offers configurable log levels, including 'fatal', 'error', 'warn', 'info', 'debug', 'trace', and 'silent'. Users can also add custom properties to log messages.
192+
The [JSON Logger Plugin](https://github.com/amplication/plugins/tree/master/plugins/logger-json) is designed for logging in JSON format. It offers configurable log levels, including 'fatal', 'error', 'warn', 'info', 'debug', 'trace', and 'silent'. Users can also add custom properties to log messages.
199193

200194
### MQTT
201195

202196
MQTT (Message Queuing Telemetry Transport) is an ISO standard publish-subscribe-based messaging protocol. It is designed for connections with remote locations where a "small code footprint" is required or the network bandwidth is limited. MQTT is highly scalable and is ideal for IoT devices, mobile applications, and messaging applications that require minimal data packets for communication.
197+
198+
### RabbitMQ Message Broker
199+
200+
Use RabbitMQ as a message broker to facilitate communication between your services.
201+
202+
[RabbitMQ](https://github.com/amplication/plugins/tree/master/plugins/broker-rabbitmq) is a robust, open-source message-queuing software that implements the Advanced Message Queuing Protocol (AMQP). It's known for its reliability, scalability, and support for multiple messaging protocols, making it an excellent choice for building distributed systems and microservices architectures.
203+
204+
### GitHub Codespaces Dev Container
205+
206+
Streamline your development environment setup with the [GitHub Codespaces Dev Container](https://github.com/amplication/plugins/tree/master/plugins/devcontainer-github-codespaces) plugin. This plugin configures a consistent, reproducible development environment using GitHub Codespaces, ensuring that all team members work with the same tools and dependencies.
207+
208+
### Keycloak Authentication Provider
209+
210+
Enhance your service's security with the [Keycloak Authentication Provider](https://github.com/amplication/plugins/tree/master/plugins/auth-keycloak) plugin. Keycloak is an open-source identity and access management solution that provides single sign-on, identity federation, and user management capabilities, allowing you to easily implement robust authentication and authorization in your applications.
211+
212+
### SAML Authentication Provider
213+
214+
Implement SAML (Security Assertion Markup Language) authentication in your service with the [SAML Authentication Provider](https://github.com/amplication/plugins/tree/master/plugins/auth-saml) plugin. SAML is an XML-based open standard for exchanging authentication and authorization data between parties, particularly between an identity provider and a service provider.
215+
216+
### HTTPS Transport
217+
218+
Secure your API communications with the [HTTPS Transport](https://github.com/amplication/plugins/tree/master/plugins/transport-https) plugin. This plugin enables HTTPS (Hypertext Transfer Protocol Secure) for your service, ensuring that all data transmitted between the client and server is encrypted and secure.

docs/getting-started/first-service.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@ sidebar_label: Create Your First Service
66
slug: /first-service
77
---
88

9-
# Create Your First Service With Amplication
9+
# Create Your First Service
1010

11-
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.
11+
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.
1212

13-
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.
13+
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.
1414

15-
This guide will help you create your first service using our streamlined service creation onboarding wizard.
15+
This guide will help you create your first service using our creation wizard.
1616

17-
:::tip
18-
[Amplication's AI](/amplication-ai) can help you build your first service with a single request in a few seconds.
19-
20-
Ask Jovu: `Can you create a new blog service with entities for posts, categories, authors, and comments?`
17+
:::info Generated Service Example
18+
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.
2119
:::
2220

2321
## Prerequisites
@@ -26,12 +24,32 @@ First, [sign up](https://app.amplication.com/login) for an Amplication account w
2624

2725
![](./assets/first-service/amplication-home-page.png)
2826

29-
If this is your first time using Amplication, the Service Creation Wizard start automatically will guide you through the process.
27+
If this is your first time using Amplication, the Service Creation Wizard will automatically guide you through the process.
3028

3129
## Step 1: Name Your Service
3230

3331
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.
3432

33+
<details>
34+
<summary>Available Technology Stacks</summary>
35+
36+
Amplication supports two technology stacks for your backend services:
37+
38+
**Node.js**
39+
- NestJS framework
40+
- Prisma ORM
41+
- GraphQL and REST APIs
42+
- React Admin UI
43+
44+
**.NET**
45+
46+
- ASP.NET Core
47+
- Entity Framework Core
48+
- REST APIs
49+
50+
Choose the stack that best fits your team's expertise and project requirements during service creation.
51+
</details>
52+
3553
![](./assets/first-service/service-name.png)
3654

3755
## Step 2: Connect Your GitHub Repository
@@ -47,7 +65,7 @@ You can also create a new repository by clicking on the **Create repository** bu
4765

4866
![](./assets/first-service/select-repository.png)
4967

50-
:::note
68+
:::note Other Supported Git Providers
5169
In addition to GitHub, Amplication also supports [Bitbucket](/sync-with-bitbucket) and [AWS CodeCommit](/sync-with-aws-codecommit) for Enterprise users.
5270
:::
5371

@@ -87,16 +105,16 @@ Monorepo is recommended if you plan on having multiple services in a single GitH
87105
Amplication supports PostgreSQL, MongoDB, and MySQL out of the box. Choose the one that suits your needs.
88106

89107
:::tip
90-
You're not locked into your choice - you can always change your database type later in your project's plugin page.
108+
You're not locked into your choice - you can always [change your database type later](/plugins/guides/database/) in your project's plugin page.
91109
:::
92110

93111
![](./assets/first-service/database.png)
94112

95113
## Step 6: Define Your Data Model
96114

97-
Define entities and fields for your database. You can manually define your own or use a template provided by Amplication.
115+
Define entities and fields for your database. You can manually define your own or use a set of pre-defined entities provided by Amplication.
98116

99-
:::info
117+
:::info What Are Entities?
100118
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.
101119

102120
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
118136

119137
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.
120138

121-
:::note
122-
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:
123-
124-
[Amplication Generated Service Sample App](https://github.com/amplication/sample-app)
125-
:::
126-
127139
![](./assets/first-service/service-created-successfully.png)
128140

129141
## Next Steps

docs/getting-started/generated-app.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,22 @@ When you use Amplication to create your backend service, we automatically genera
1111

1212
Some of the key features of our generated backend services include:
1313

14-
- **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.
15-
- **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.
16-
- **Ready for Production**: The generated services include Docker configurations, CI/CD pipelines, and are optimized for cloud deployment, making it straightforward to move from development to production.
17-
- **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.
18-
19-
:::note
20-
You can see an example of a Node.js service generated with Amplication in this [GitHub repository](https://github.com/amplication/sample-app).
14+
- **Comprehensive APIs**: Every service includes REST APIs with built-in validation, documentation, and testing capabilities. Optional GraphQL support is available for enhanced data querying.
15+
- **Authentication & Authorization**: Built-in user management, role-based access control, and security best practices.
16+
- **Database Integration**: Robust database connectivity with your choice of modern ORMs and data validation.
17+
- **Developer Experience**: Generated services include logging, testing frameworks, and development tools configured according to industry standards.
18+
- **Production-ready**: Includes Docker configurations and CI/CD pipelines for straightforward deployment to your preferred platform.
19+
- **Extensible Architecture**: Clean, modular architecture that separates business logic from infrastructure concerns, making the code easy to maintain and customize.
20+
21+
:::info Generated Service Example
22+
See an example of a generated service in our [sample application repository](https://github.com/amplication/sample-app).
2123
:::
2224

2325
## Technologies
2426

2527
The generated services utilize a suite of proven, robust technologies tailored for each supported technology.
2628

27-
Below are the technologies employed for Node.js and .NET, ensuring efficient, reliable, and scalable server-side applications.
29+
Below are the technologies used for Amplication's supported tech stacks, ensuring efficient, reliable, and scalable server-side apps.
2830

2931
### Server-side
3032

0 commit comments

Comments
 (0)