Skip to content

Commit

Permalink
Merge branch 'docs/plugins-cleanup' of https://github.com/amplication…
Browse files Browse the repository at this point in the history
…/docs into docs/plugins-cleanup
  • Loading branch information
dericksozo committed Dec 4, 2024
2 parents 06a35df + e5ddcb6 commit 06a964d
Show file tree
Hide file tree
Showing 19 changed files with 366 additions and 121 deletions.
4 changes: 2 additions & 2 deletions docs/faqs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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

Expand Down
48 changes: 30 additions & 18 deletions docs/getting-started/first-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

<details>
<summary>Available Technology Stacks</summary>

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.
</details>

![](./assets/first-service/service-name.png)

## Step 2: Connect Your GitHub Repository
Expand All @@ -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.
:::

Expand Down Expand Up @@ -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)
Expand All @@ -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.
Expand All @@ -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
Expand Down
18 changes: 10 additions & 8 deletions docs/getting-started/generated-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading

0 comments on commit 06a964d

Please sign in to comment.