mlh-fellowship / amplify-cli-monorepo-tour

Walk, jog and run through the Amazon Amplify CLI monorepo

Amplify CLI Monorepo Tour

The Amplify Command Line Interface (CLI) monorepo tour is a guide for software developers by software developers. This guide aims to help new Amazon engineers and the huge awesome community of open source contributors to get started with the development and improvement of the Amplify CLI.

Installation

yarn install

Local Development

yarn start

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

Build

yarn 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 yarn 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.

amplify-cli-monorepo-tour's Issues

Set up and initialize docusaurus project

Create a docusaurus project with classic template.

We identified some disadvantages in presenting the Amplify CLI architecture as a CLI:-

• Images/flowcharts are not visually appealing when displayed on the terminal via a CLI.
• CLI demands a design of the flow in which we want to guide users or ask questions to them. Flow design might be time consuming and might deviate and reduce focus from understanding and learning about the code in amplify-cli repo.
• In case time permits we can make the CLI. For now we can make simple markdown notes for docusaurus website. We figured an alternative idea to present our docusaurus website as well.

amplify-env code walkthrough

Explain amplify-env working and flow.

amplify-mock code walkthrough

Explain amplify-mock working.

amplify-cli code walkthrough

Explain user data and cli flow in the code base for amplify-cli package.

Landing page header, footer and navbar design

Modify design according to Amplify theme.