You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 6, 2025. It is now read-only.
Copy file name to clipboardexpand all lines: docs/custom-code/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Customize Your Application
4
4
5
5
# Customize Your Application
6
6
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.
Copy file name to clipboardexpand all lines: docs/faqs/faqs.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Here are some questions that we are asked about frequently about using Amplicati
12
12
13
13
### What is Amplication?
14
14
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.
16
16
17
17
### How does Amplication work?
18
18
@@ -57,7 +57,7 @@ Amplication offers a structured way to [add custom code](https://docs.amplicatio
57
57
58
58
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.
59
59
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.
Copy file name to clipboardexpand all lines: docs/getting-started/first-service.md
+31-19
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,16 @@ sidebar_label: Create Your First Service
6
6
slug: /first-service
7
7
---
8
8
9
-
# Create Your First Service With Amplication
9
+
# Create Your First Service
10
10
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.
12
12
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.
14
14
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.
16
16
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.
21
19
:::
22
20
23
21
## Prerequisites
@@ -26,12 +24,32 @@ First, [sign up](https://app.amplication.com/login) for an Amplication account w
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.
30
28
31
29
## Step 1: Name Your Service
32
30
33
31
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.
34
32
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
+
35
53

36
54
37
55
## Step 2: Connect Your GitHub Repository
@@ -47,7 +65,7 @@ You can also create a new repository by clicking on the **Create repository** bu
47
65
48
66

49
67
50
-
:::note
68
+
:::note Other Supported Git Providers
51
69
In addition to GitHub, Amplication also supports [Bitbucket](/sync-with-bitbucket) and [AWS CodeCommit](/sync-with-aws-codecommit) for Enterprise users.
52
70
:::
53
71
@@ -87,16 +105,16 @@ Monorepo is recommended if you plan on having multiple services in a single GitH
87
105
Amplication supports PostgreSQL, MongoDB, and MySQL out of the box. Choose the one that suits your needs.
88
106
89
107
:::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.
91
109
:::
92
110
93
111

94
112
95
113
## Step 6: Define Your Data Model
96
114
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.
98
116
99
-
:::info
117
+
:::info What Are Entities?
100
118
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.
101
119
102
120
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
118
136
119
137
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.
120
138
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)
Copy file name to clipboardexpand all lines: docs/getting-started/generated-app.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -11,20 +11,22 @@ When you use Amplication to create your backend service, we automatically genera
11
11
12
12
Some of the key features of our generated backend services include:
13
13
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 are optimized for [deployment](/deploy/), include Docker configurations and CI/CD pipelines, 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).
21
23
:::
22
24
23
25
## Technologies
24
26
25
27
The generated services utilize a suite of proven, robust technologies tailored for each supported technology.
26
28
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.
Copy file name to clipboardexpand all lines: docs/getting-started/plugins.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,11 @@ If you choose to turn on authentication for your service, that will enable Authe
22
22
Ask Jovu: `Which plugins do you recommend for adding caching capabilities to my Amplication service?`
23
23
:::
24
24
25
-
## Node.js and .NET Plugins
25
+
## Available Plugins
26
26
27
27
Amplication supports both Node.js and .NET for code generation. Plugins are technology-specific.
28
28
29
-
When you switch between Node.js and .NET, you'll see a different set of available plugins, each optimized for the chosen stack.
29
+
Node.js and .NET services will see a different set of available plugins, each optimized for the chosen stack.
30
30
31
31
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.
Copy file name to clipboardexpand all lines: docs/getting-started/service-entities-roles-permissions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,9 @@ The _Entities_ page opens. Here you see all the entities in your application.
30
30

31
31
32
32
:::info
33
-
When you initially established your service using the service creation wizard, you had the choice to [incorporate entities into your data model](/first-service/#step-6-define-your-data-model) from an Amplication template, or leave it empty.
33
+
When you initially established your service using the service creation wizard, you had the choice to [incorporate entities into your service](/first-service/#step-6-define-your-data-model) from a set of pre-defined entities, or leave it empty.
34
34
35
-
If you opted not to use a template, you'll find your Entities screen with only one entity, **User**. This entity auto-generated when you created the new service.
35
+
If you opted not to use the pre-defined entities, you'll find your Entities screen with only one entity, **User**. This entity auto-generated when you created the new service.
36
36
:::
37
37
38
38
In this example, we'll now add another entity called _Project_.
Copy file name to clipboardexpand all lines: docs/getting-started/set-up-entities.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -34,9 +34,9 @@ The _Entities_ page opens. Here you see all the entities in your application.
34
34

35
35
36
36
:::info
37
-
When you initially established your service using the service creation wizard, you had the choice to [incorporate entities into your data model](/first-service/#step-6-define-your-data-model) from an Amplication template, or leave it empty.
37
+
When you initially established your service using the service creation wizard, you had the choice to [incorporate entities into your service](/first-service/#step-6-define-your-data-model) from a set of pre-defined entities, or leave it empty.
38
38
39
-
If you opted not to use a template, you'll find your Entities screen with only one entity, **User**. This entity auto-generated when you created the new service.
39
+
If you opted not to use the pre-defined entities, you'll find your Entities screen with only one entity, **User**. This entity auto-generated when you created the new service.
40
40
:::
41
41
42
42
In this example, we'll now add another entity called _Project_.
0 commit comments