Transform platform engineering with tailor-made live templates and service catalog 🚀
Introduction
Amplication enables you to quickly build, maintain, and scale backend services that embed your company’s best practices and standards.
With Amplication you can create your own live templates embedding your organization’s best practices and standards, to ensure consistency and compliance from the start.
Leveraging AI-powered automation, Amplication will generate microservices in no time, with everything that is needed to support your business domain: APIs, data models, DTOs and more, allowing engineers to focus on business logic.
Now your live applications will be always up-to-date. Amplication automatically handles package updates, patches, and versioning, reducing technical debt and ensuring consistency across your services.
Features
Usage
To get started with Amplication, the hosted version of the product can be used. You can get started immediately at app.amplication.com. After the login page, you will be guided through creating your first service. The website provides an overview of the application, additional information on the product and guides can be found in the docs.
Tutorials
Development
Alternatively, instead of using the hosted version of the product, Amplication can be run locally for code generation purposes or contributions - if so, please refer to our contributing section.
Pre-requisites
To be able to start development on Amplication, make sure that you have the following prerequisites installed:
- Node.js
- Docker
- Git
Running Amplication
Note It is also possible to start development with GitHub Codespaces, when navigating to
< > Code, selectCodespacesinstead ofLocal. Click on either the+-sign or theCreate codespace on master-button.
Amplication is using a monorepo architecture - powered by Nx Workspaces - where multiple applications and libraries exist in a single repository. To setup a local development environment the following steps can be followed:
BEFORE you run the following steps make sure:
-
You have typescript installed locally on you machine
npm install -g typescript -
You are using a supported node version (check
enginesnodein the package.json) -
You are using a supported npm version (check
enginesnpmin the package.json) -
You have
dockerinstalled and running on your machine -
Clone the repository and install dependencies:
git clone https://github.com/amplication/amplication.git && cd amplication && npm install- Run the setup script, which takes care of installing dependencies, building packages, and setting up the workspace:
npm run setup:dev- Option 1: Running the required infrastructure - view infrastructure component logs
npm run docker:dev- Option 2: Running the required infrastructure - run the infrastructure components in background
npm run docker:dev -- -d- Apply database migrations
npm run db:migrate:deploy- To start developing, run one or more of the applications available under
serve:[application]scripts of the package.json.
# running the server component
npm run serve:server
# running the client component
npm run serve:client
# running the data-service-generator component
npm run serve:dsg
# running the git-sync-manager component
npm run serve:git
# running the plugin-api component
npm run serve:pluginsNote In order to run the Amplication client properly, both the client and server need to be started by the
npm run serve:[application]command, as well as an additional component for development on a specific component.
The development environment should now be set up. Additional information on the different application components can be found under packages/[application]/README.md file. Happy hacking! 👾
Resources
- Website overview of the product.
- Docs for comprehensive documentation.
- Blog for guides and technical comparisons.
- Discord for support and discussions with the community and the team.
- GitHub for source code, project board, issues, and pull requests.
- Twitter for the latest updates on the product and published blogs.
- YouTube for guides and technical talks.
Contributing
The majority of Amplication code is open-source. We are committed to a transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as a part of the Amplication community. Please refer to our contribution guidelines and code of conduct.
-
Bug Report: If you see an error message or encounter an issue while using Amplication, please create a bug report.
-
Feature Request: If you have an idea or if there is a capability that is missing and would make development easier and more robust, please submit a feature request.
-
Documentation Request: If you're reading the Amplication docs and feel like you're missing something, please submit a documentation request.
Not sure where to start? Join our discord and we will help you get started!
Contributors
License
A large part of this project is licensed under the Apache 2.0 license. The only exception are the components under the ee (enterprise edition) directory, these are licensed under the Amplication Enterprise Edition license.