Skip to main content
  1. All Posts/

amplication

Tools TypeScript


<p>
  </a>
</p>

<p>
  <a rel="nofollow noopener" target="_blank" href="https://opensource.org/licenses/Apache-2.0"></p> 
  
  <p>
    </a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/dd57ddcf8697200634b4f2499ac0a9abc7986e4b08d275cd849cf2995193f156/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f616d706c69636174696f6e2f616d706c69636174696f6e3f636f6c6f723d707572706c65"></a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="#contributors-"></a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://user-images.githubusercontent.com/53312820/190913686-02c7deb1-da2f-41b8-aa31-065e00f6155c.png"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://amplication.com/">Amplication</a> is an open‑source development platform. It helps professional Node.js developers build quality Node.js applications without spending time on repetitive coding tasks.<br /> Amplication auto-generates backend apps built with TypeScript and Node.js, and a client built with React.
  </p>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-features" class="anchor" aria-hidden="true" href="#features"></a>Features
  </h1>
  
  <p>
    Amplication provides the following features:
  </p>
  
  <ul dir="auto">
    <li>
      Production-ready APIs
    </li>
    <li>
      Data Model
    </li>
    <li>
      Role Based Access Control (RBAC)
    </li>
    <li>
      Microservices Support
    </li>
    <li>
      Continuous GitHub Sync
    </li>
    <li>
      TypeScript and Node.js Source Code
    </li>
    <li>
      Plugin System
    </li>
    <li>
      Monorepo or Polyrepo
    </li>
    <li>
      Custom Code
    </li>
    <li>
      Admin UI
    </li>
    <li>
      Amplication Console & CLI
    </li>
  </ul>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-getting-started" class="anchor" aria-hidden="true" href="#getting-started"></a>Getting Started
  </h1>
  
  <p>
    You can get started with Amplication immediately on the Amplication Cloud.<br /> Alternatively you can set up a local development environment.<br /> See the <a rel="nofollow noopener" target="_blank" href="http://amplication.com/">Amplication Website</a> or <a rel="nofollow noopener" target="_blank" href="http://docs.amplication.com/">Amplication Docs</a> for more details.
  </p>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-tutorials" class="anchor" aria-hidden="true" href="#tutorials"></a>Tutorials
  </h2>
  
  <ul dir="auto">
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://docs.amplication.com/tutorials/angular-todos/">Todo Application using Amplication and Angular</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://docs.amplication.com/tutorials/react-todos/">Todo Application using Amplication and React</a>
    </li>
  </ul>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-amplication-cloud-saas" class="anchor" aria-hidden="true" href="#amplication-cloud-saas"></a>Amplication Cloud (SaaS)
  </h2>
  
  <p>
    Launch Amplication from <a rel="nofollow noopener" target="_blank" href="http://app.amplication.com/">app.amplication.com</a>
  </p>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-development-environment-local" class="anchor" aria-hidden="true" href="#development-environment-local"></a>Development Environment (Local)
  </h2>
  
  <h3 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-system-requirements" class="anchor" aria-hidden="true" href="#system-requirements"></a>System Requirements
  </h3>
  
  <p>
    💡 Before you begin, make sure you have the following installed:
  </p>
  
  <ul dir="auto">
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://nodejs.org/en/download/">Node.js v16 or above</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://docs.docker.com/desktop/">Docker</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git/">Git</a>
    </li>
  </ul>
  
  <h3 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-getting-started-with-local-development" class="anchor" aria-hidden="true" href="#getting-started-with-local-development"></a>Getting Started With Local Development
  </h3>
  
  <p>
    Amplication is using a monorepo (powered by <a rel="nofollow noopener" target="_blank" href="https://nx.dev/">Nx Workspaces</a>) with multiple apps and libraries.<br /> Follow these simple instructions to set up a local development environment.
  </p>
  
  <ol dir="auto">
    <li>
      Clone the repository and install dependencies:
    </li>
  </ol>
  
  <pre>git clone https://github.com/amplication/amplication.git

cd amplication npm install

  <ol start="2" dir="auto">
    <li>
      Run the setup script, which takes care of installing dependencies, building packages and ensuring your workspace is dev-ready.
    </li>
  </ol>
  
  <pre>npm run setup:dev</pre>
  
  <ol start="3" dir="auto">
    <li>
      Spin up all required infrastructure (Postgres, Kafka, etc.) using Docker Compose:
    </li>
  </ol>
  
  <pre># To be able to view logs

npm run docker:dev

Or, if you prefer to run it at the background>

Or, if you prefer to run it at the background #

npm run docker:dev – -d

  <ol start="4" dir="auto">
    <li>
      Apply database migrations:
    </li>
  </ol>
  
  <pre>npm run db:migrate:deploy</pre>
  
  <ol start="5" dir="auto">
    <li>
      To start developing, run the <code>serve</code> target of the desired app:
    </li>
  </ol>
  
  <pre># This will serve the Amplication Server in development mode

npx nx serve amplication-server

This will serve the Amplication Client in development mode>

This will serve the Amplication Client in development mode #

npx nx serve amplication-client

  <p>
    That&#8217;s it, you are good to go! Happy hacking! 👾<br /> You can always find more information in each app/library&#8217;s respective README.md file.
  </p>
  
  <h3 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-setting-up-amplication-manually" class="anchor" aria-hidden="true" href="#setting-up-amplication-manually"></a>Setting Up Amplication Manually
  </h3>
  
  <p>
    You can use a manual step-by-step approach to set up Amplication in a local development environment. To do so, you should follow the following instructions for <strong>Setting Up Amplication Server</strong>, and <strong>Setting Up Amplication Client</strong>.
  </p>
  
  <h4 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-setting-up-amplication-server" class="anchor" aria-hidden="true" href="#setting-up-amplication-server"></a>Setting up Amplication Server<br />
  </h4>
  
  <p>
    Amplication Server is the main component of the platform that provides all the core functionality to design and create low-code applications.<br /> The server exposes a GraphQL API for all actions. The server is built with the following awesome open-source technologies: Node.js, NestJS, Prisma over PostgreSQL, GraphQL API, and many more&#8230;
  </p>
  
  <h4 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-setting-up-amplication-client" class="anchor" aria-hidden="true" href="#setting-up-amplication-client"></a>Setting Up Amplication Client<br />
  </h4>
  
  <p>
    Amplication Client is the front end of the platform that provides you with an easy-to-drive UI for building your next low-code application.<br /> The client is based on React, Apollo client, Primer components, React Material Web Components, Formik, and more.
  </p>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-version-1" class="anchor" aria-hidden="true" href="#version-1"></a>Version 1
  </h1>
  
  <p>
    Amplication is currently in version 1. This is the first major release of Amplication with enterprise-grade production readiness & scale. In this version, we have introduced multiple new features and enhanced the existing ones. The feature set is listed above in the <a rel="nofollow noopener" target="_blank" href="#features">Features</a> section.
  </p>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-support" class="anchor" aria-hidden="true" href="#support"></a>Support
  </h2>
  
  <p>
    Ask your questions and participate in discussions regarding Amplication-related and web-dev topics at the Amplication Discord server.<br /> <a rel="nofollow noopener" target="_blank" href="https://discord.gg/Z2CG3rUFnu"></a>
  </p>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-create-a-bug-report" class="anchor" aria-hidden="true" href="#create-a-bug-report"></a>Create a Bug Report
  </h2>
  
  <p>
    If you see an error message or run into an issue, please create bug report. This effort is valued and helps all Amplication users.
  </p>
  
  <h2 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-submit-a-feature-request" class="anchor" aria-hidden="true" href="#submit-a-feature-request"></a>Submit a Feature Request
  </h2>
  
  <p>
    If you have an idea, or you&#8217;re missing a capability that would make development easier and more robust, please Submit feature request.<br /> If a similar feature request already exists, don&#8217;t forget to leave a &#8220;+1&#8221;.<br /> If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly 🙂
  </p>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-contributing" class="anchor" aria-hidden="true" href="#contributing"></a>Contributing
  </h1>
  
  <p>
    Amplication is an open-source project. We are committed to a fully 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 &#8211; we would love to have you as a part of the Amplication community.
  </p>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-useful-links" class="anchor" aria-hidden="true" href="#useful-links"></a>Useful Links
  </h1>
  
  <ul dir="auto">
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://docs.amplication.com/">Docs</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://amplication.com/blog">Blog</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://twitter.com/amplication">Twitter</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://amplication.com/discord">Discord</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="https://www.youtube.com/c/Amplicationcom">Youtube</a>
    </li>
  </ul>
  
  <p>
    Please refer to our Contribution Guidelines and Code of Conduct.
  </p>
  
  <h1 dir="auto">
    <a rel="nofollow noopener" target="_blank" id="user-content-contributors-" class="anchor" aria-hidden="true" href="#contributors-"></a>Contributors ✨<br />
  </h1>
  
  <p>
    Thanks goes to these wonderful people (<a rel="nofollow noopener" target="_blank" href="https://allcontributors.org/docs/en/emoji-key">🤗</a>):
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://amplication.com/">Yuval Hazaz</a>💻
  </p>
  
  <p>
    Roy Belkind⚠️ 🐛 💻
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://cegla.me">Gal Cegla</a>⚠️ 🐛 💻
  </p>
  
  <p>
    Alon Ram💻 ⚠️ 🐛 <a rel="nofollow noopener" target="_blank" href="#content-alonram" title="Content">🖋</a>
  </p>
  
  <p>
    meeroslava💻 ⚠️ 🐛 <a rel="nofollow noopener" target="_blank" href="#content-meeroslava" title="Content">🖋</a>
  </p>
  
  <p>
    danna📖
  </p>
  
  <p>
    Almog Langleben💻
  </p>
  
  <p>
    tupe12334💻 🐛
  </p>
  
  <p>
    Gabriel Moncea💻
  </p>
  
  <p>
    m3llo96📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://petarvujovi%C4%87">Petar Vujović</a>💻 🐛
  </p>
  
  <p>
    yam-golombek📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://aniddan.com">Iddan Aaronsohn</a>💻 🐛 <a rel="nofollow noopener" target="_blank" href="#content-iddan" title="Content">🖋</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://Timdurward.github.io">Tim Durward</a>💻 <a rel="nofollow noopener" target="_blank" href="#infra-TimDurward" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> 📖
  </p>
  
  <p>
    yonantan💻
  </p>
  
  <p>
    hermanramaniuk💻 ⚠️
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://www.linkedin.com/profile/view?id=AAIAABLBfC4BE232yLpsGEF-dPR_QMXNvqrVucM&trk=nav_responsive_tab_profile_pic">George Cameron</a>📖
  </p>
  
  <p>
    Leeyaacov📖 <a rel="nofollow noopener" target="_blank" href="#design-Leeyaacov" title="Design">🎨</a> <a rel="nofollow noopener" target="_blank" href="#content-Leeyaacov" title="Content">🖋</a>
  </p>
  
  <p>
    Mikayel Ohanjanyan 💻
  </p>
  
  <p>
    Lalit C.💻
  </p>
  
  <p>
    dabelh⚠️
  </p>
  
  <p>
    liyachun💻
  </p>
  
  <p>
    isabr85📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://kapustakrzysztof.pl">Krzysztof Kapusta</a>💻
  </p>
  
  <p>
    Eric Hodges📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://0xflotus.github.io">0xflotus</a>📖
  </p>
  
  <p>
    MatanForU<a rel="nofollow noopener" target="_blank" href="#design-MatanForU" title="Design">🎨</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://www.enotriacoe.com">Richard Weaver</a><a rel="nofollow noopener" target="_blank" href="#ideas-richardweaver" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    NullF0rest<a rel="nofollow noopener" target="_blank" href="#ideas-NullF0rest" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    sandbox-apps<a rel="nofollow noopener" target="_blank" href="#ideas-sandbox-apps" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    Victor Mota<a rel="nofollow noopener" target="_blank" href="#example-vimota" title="Examples">💡</a> <a rel="nofollow noopener" target="_blank" href="#ideas-vimota" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    Kelello<a rel="nofollow noopener" target="_blank" href="#example-Kelz29" title="Examples">💡</a>
  </p>
  
  <p>
    MatthiasWanner<a rel="nofollow noopener" target="_blank" href="#ideas-MatthiasWanner" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    regicsolutions<a rel="nofollow noopener" target="_blank" href="#ideas-regicsolutions" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://sten.pw">Sten Feldman</a><a rel="nofollow noopener" target="_blank" href="#ideas-exsilium" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://knsblog.com">Thuc Pham</a><a rel="nofollow noopener" target="_blank" href="#example-thucpn" title="Examples">💡</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://codylacey.com">Cody Lacey</a>💻
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://amplication.com">Matan Shidlov</a>💻 <a rel="nofollow noopener" target="_blank" href="#content-mshidlov" title="Content">🖋</a>
  </p>
  
  <p>
    michizhou💻
  </p>
  
  <p>
    Guillaume Traub💻
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://leetcode.com/purpl3/">Asian Cat</a><a rel="nofollow noopener" target="_blank" href="#blog-AsianCat54x" title="Blogposts">📝</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://www.noyagasi.com">Noy Agasi</a>💻 🐛
  </p>
  
  <p>
    Rutam Prita Mishra📖
  </p>
  
  <p>
    Alex Bass<a rel="nofollow noopener" target="_blank" href="#design-alexbass86" title="Design">🎨</a> 🐛
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://linkedin.com/in/mike-nu%C3%9Fbaumer">Mike Nußbaumer</a><a rel="nofollow noopener" target="_blank" href="#ideas-mikenussbaumer" title="Ideas, Planning, & Feedback">🤔</a> 🐛
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://www.linkedin.com/in/amitbarletz/">Amit Barletz</a>💻 📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://www.amplication.com%20">Moshe Forman</a>📖
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://m-agboola.web.app">Mohammed Agboola®️</a>💻 🐛
  </p>
  
  <p>
    morhag90💻
  </p>
  
  <p>
    Kwinten Li💻
  </p>
  
  <p>
    EdroViegas🐛
  </p>
  
  <p>
    Hassan Miiro<a rel="nofollow noopener" target="_blank" href="#ideas-hmiiro" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://michaelsolati.com">Michael Solati</a>💻
  </p>
  
  <p>
    Mohamed Muhsin💻
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="https://asiancat54.ml">0xsapphir3</a>🐛
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://jnfrati.github.io">Nicolas Frati</a><a rel="nofollow noopener" target="_blank" href="#ideas-jnfrati" title="Ideas, Planning, & Feedback">🤔</a>
  </p>
  
  <p>
    Utsav Paul<a rel="nofollow noopener" target="_blank" href="#maintenance-Smartmind12" title="Maintenance">🚧</a>
  </p>
  
  <p>
    <a rel="nofollow noopener" target="_blank" href="http://santoshb.com.np">Santosh Bhandari</a>💻
  </p>
  
  <p>
    Vincenzo Domina💻
  </p>
  
  <p>
    This project follows the all-contributors specification. Contributions of any kind welcome!<br />
  </p>