Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

amplication/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

fb9b3d4 · Feb 6, 2025
Mar 22, 2023
Dec 11, 2022
Dec 17, 2024
Aug 14, 2022
Dec 9, 2024
Oct 18, 2023
Mar 20, 2023
Aug 14, 2022
Oct 10, 2023
Feb 6, 2025
Nov 1, 2020
Dec 9, 2024
Nov 22, 2022
Mar 22, 2023
Mar 22, 2023
Dec 17, 2024

Repository files navigation

📝 Note
Amplication Documentation moved to https://github.com/amplication/amplication-docs

Amplication Documentation

Welcome to the Amplication documentation repository! This repository contains the documentation for the Amplication open-source development platform. Amplication is a low-code development platform that allows developers to quickly build scalable and maintainable applications.

The documentation provides detailed information on how to use the platform, including tutorials, guides, and reference material. This website is built using Docusaurus 2, a modern static website generator.

Installation

npm ci

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Contributing

We welcome contributions to the Amplication documentation! If you find an issue or want to suggest an improvement, please open a GitHub issue and then submit a pull request.