Introduction
Amplication is a robust, open-source development platform designed to revolutionize the creation of scalable and secure .NET and Node.js applications. Amplication is the only AI platform turning ideas into production-ready code in a few minutes. We automate your backend applications development, ensuring consistency, predictability, and adherence to the highest standards with code that’s built to scale
Our user-friendly interface fosters seamless integration of APIs, data models, databases, authentication, and authorization. Built on a flexible, plugin-based architecture, Amplication allows effortless customization of the code and offers a diverse range of integrations.
With a strong focus on collaboration, Amplication streamlines team-oriented development, making it an ideal choice for groups of all sizes, from startups to large enterprises. Our platform enables you to concentrate on your business logic, while we handle the heavy lifting.
Experience the fastest way to develop .NET and Node.js applications with Amplication.
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.
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.
- Node.js
- Docker
- Git
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:plugins
Note
In order to run the Amplication client properly, both the client and server need to be started by thenpm 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.