Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amplication/docs
Amplication docs
https://github.com/amplication/docs
amplication hacktoberfest
Last synced: 17 days ago
JSON representation
Amplication docs
- Host: GitHub
- URL: https://github.com/amplication/docs
- Owner: amplication
- License: apache-2.0
- Created: 2020-10-31T07:46:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T05:57:22.000Z (9 months ago)
- Last Synced: 2024-04-04T20:24:54.496Z (9 months ago)
- Topics: amplication, hacktoberfest
- Language: JavaScript
- Homepage: https://docs.amplication.com
- Size: 64.1 MB
- Stars: 16
- Watchers: 9
- Forks: 58
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Amplication Documentation
Welcome to the [Amplication documentation](https://docs.amplication.com/) 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](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
npm ci
```
## Local Development
```console
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
```console
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER= 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](https://github.com/amplication/amplication/issues/new/choose) and then submit a pull request.