How to Use Amplication

Getting started with Amplication

In this guide, you will learn how to set up an account and create your first backend microservice using Amplication. By the end, you’ll be able to generate scalable backend solutions quickly and efficiently.

Step 1: Sign up and set up

1. Go to Amplication's website.
2. Click on the "Get Started" button in the top right corner.
3. You can sign up using your email or a GitHub account. Choose your preferred option and follow the prompts to create your account.
4. Once signed in, you will be directed to the Amplication dashboard.

Step 2: Your first microservice

1. On the dashboard, click on the “New Project” button.
2. Enter a name for your project and select a template (e.g., Node.js or .NET).
3. Click “Create Project”.
4. In the project editor, click on “Models” in the left sidebar to define your data structure.
5. Click on “Add Model” and enter the model name (e.g., "User"). Define the fields (e.g., "Name" as a String, "Email" as a String).
6. After defining your models, click on the “Generate” button in the top right corner.
7. Select your preferred options (e.g., authentication settings) and click “Generate Code”.
8. Once the code is generated, you can download it directly to your machine.

Step 3: Get better results

1. Explore the "Settings" tab to configure project settings such as database connections and environment variables.
2. Use the “Documentation” link in the footer for detailed explanations of each feature.
3. Regularly update your models and regenerate the code to keep your backend aligned with your project requirements.

Pro tip

Take advantage of the “Import Model” feature to quickly bring in existing database schemas. This saves time by automatically generating models based on your current database structure.

Common mistake to avoid

Avoid neglecting to check the “Authentication” settings before generating your code. Failing to configure these settings can lead to security vulnerabilities in your microservice. Always ensure your authentication options are set according to your project needs.