Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amplication/amplication

Amplication brings order to the chaos of large-scale software development by creating Golden Paths for developers - streamlined workflows that drive consistency, enable high-quality code practices, simplify onboarding, and accelerate standardized delivery across teams.
https://github.com/amplication/amplication

api code-generation csharp csharp-code dotnet dotnet-core graphql hacktoberfest javascript low-code nestjs nodejs prisma typescript web

Last synced: 6 days ago
JSON representation

Amplication brings order to the chaos of large-scale software development by creating Golden Paths for developers - streamlined workflows that drive consistency, enable high-quality code practices, simplify onboarding, and accelerate standardized delivery across teams.

Awesome Lists containing this project

README 

        


    

    

    

    

    

    






  Transform platform engineering with tailor-made live templates and service catalog 🚀






  

    continuous integration

  

  

    contributors

  

  

    license

  

  


  

    discord

  

  

    twitter

  

  

    youtube

  






    dashboard




## 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

 





    apis

 

    data-models






    plugins

 

    microservices

 

    



    own-your-code

 

    customize-code




## Usage 



To get started with Amplication, the hosted version of the product can be used. You can get started immediately at [app.amplication.com](https://app.amplication.com). After the login page, you will be guided through creating your first service. The [website](https://amplication.com) provides an overview of the application, additional information on the product and guides can be found in the [docs](https://docs.amplication.com).



  Tutorials

 



- [To-do application using Amplication and Angular](https://docs.amplication.com/tutorials/angular-todos)

- [To-do application using Amplication and React](https://docs.amplication.com/tutorials/react-todos)



## 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](#contributing_anchor) 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`, select `Codespaces` instead of `Local`. Click on either the `+`-sign or the `Create 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:

1. You have typescript installed locally on you machine ```npm install -g typescript```

2. You are using a supported node version (check `engines` `node` in the [package.json](./package.json))

3. You are using a supported npm version (check `engines` `npm` in the [package.json](./package.json))

4. You have `docker` installed and running on your machine



1. Clone the repository and install dependencies:

```shell

git clone https://github.com/amplication/amplication.git && cd amplication && npm install

```



2. Run the setup script, which takes care of installing dependencies, building packages, and setting up the workspace:

```shell

npm run setup:dev

```



3. Option 1: Running the required infrastructure - view infrastructure component logs



```shell

npm run docker:dev

```

3. Option 2: Running the required infrastructure - run the infrastructure components in background

```shell

npm run docker:dev -- -d

```



4. Apply database migrations

```shell

npm run db:migrate:deploy

```



5. To start developing, run one or more of the applications available under `serve:[application]` scripts of the package.json.



```shell

# 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 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](https://amplication.com)** overview of the product.

- **[Docs](https://docs.amplication.com)** for comprehensive documentation.

- **[Blog](https://amplication.com/blog)** for guides and technical comparisons.

- **[Discord](https://amplication.com/discord)** for support and discussions with the community and the team.

- **[GitHub](https://github.com/amplication/amplication)** for source code, project board, issues, and pull requests.

- **[Twitter](https://twitter.com/amplication)** for the latest updates on the product and published blogs.

- **[YouTube](https://www.youtube.com/c/Amplicationcom)** 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](./CONTRIBUTING.md) and [code of conduct](./CODE_OF_CONDUCT.md).



- Bug Report: If you see an error message or encounter an issue while using Amplication, please create a [bug report](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+bug&template=bug.yaml&title=%F0%9F%90%9B+Bug+Report%3A+).



- 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](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+feature+request&template=feature.yml).



- Documentation Request: If you're reading the Amplication docs and feel like you're missing something, please submit a [documentation request](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+docs&template=documentation-request.yaml&title=%F0%9F%93%96+Documentation%3A+).



Not sure where to start? Join our discord and we will help you get started!






## Contributors



[//]: contributor-faces


















































































































[//]: contributor-faces



## License



A large part of this project is licensed under the [Apache 2.0](./LICENSE) license. The only exception are the components under the `ee` (enterprise edition) directory, these are licensed under the [Amplication Enterprise Edition](./ee/LICENSE) license.