appql-cli v0.0.15

Modular NodeJS API Server

Getting Started

Install the AppQL CLI with:

npm insatll -g appql-cli

To create a new repository to house your products, run:

appql create-repository <repo-name>

From within your new repository's root directory, you can add a new project with:

appql create-project <project-name>

This will create a new subdirectory <project-name>. Move the created Docker compose file into your repository root with something like;

mv <project-name>/docker-compose.yml docker-compose.<project-name>.yml

You can now launch your new project with:

docker-compose -f docker-compose.<project-name>.yml up

Navigate to http://localhost:3000 to see the default "hello world" message.

Repository Structure

Repositories in AppQL subscribe to the "monorepo" philosophy and are designed to house multiple projects and facilitate sharing dependent packages. There are several key features to keep in mind:

• All projects are built using Docker.
• Shared packages live under the packages subdirectory.
• Projects live under top-level directories of the same name as the project.
• Some useful scripts live under scripts.

Project Structure

Projects are broken into two primary subdirectories: server and web. The server subdirectory houses the code needed to launch a PostGraphile API server, and the web subdirectory houses the code for a React based web UI.

Deployment

Both the server and web components of each project come prepared to use Polecat to deploy to a serverless environment. AppQL offers wrappers to more easily launch standard Polecat operations.

To initialise one of your projects for deployment you can run:

appql init-app <project-name> [options]

To create an application deployment:

appql create-deployment <project-name> <deployment-name>

To set secrets for your application, you can use:

appql set-app-secret <project-name> <deployment-name> <secret-name>=<secret-value> ...

To publish your application to a domain:

appql publish-app <project-name> <deployment-name> <domain> [certificate]