Deploying Framna Docs

You may deploy Shape Docs in any way you see fit for your infrastructure. At a high level, there are the following two recommended ways of deploying Shape Docs.

Deploy in a Docker container

Framna Docs can be deployed in a Docker container after it is built and pushed to a registry as shown below.

docker build -t example/framna-docs:latest .
docker push example/framna-docs:latest

This builds the Docker image defined by the Dockerfile residing in the repository and pushes it to a registry.

At Shape, we push the Docker image to Elastic Container Registry on AWS and deploy the image using Elastic Container Service.

Deploy as a regular Node app

For anyone unfamiliar with Docker, the most straightforward way to deploy Framna Docs is likely by deploying it like a regular Node app. This is similar to running Framna Docs locally as detailed in the Running Framna Docs Locally article.

After all the environment variables have been configured, the prerequisites have been installed, and the Node modules have been installed using npm, Framna Docs can be built using the following command:

npm run build

The built application can then be started by executing this command:

npm run start

The application can also be run in standalone mode by running the node CLI directly:

node .next/standalone/server.js