Docker Support
Instructions on how to build & run each part of Keyshade using docker
This document provides instructions on how to build and run our applications using Docker.
Prerequisites
Docker must be installed on your system.
Available Applications
We have Docker support for the following applications:
Web Application
API
Platform
Building and Running Applications
Environment Variables
All applications use environment variables from a .env file. Ensure this file is present in your project root directory with the necessary configurations.
Starting and Stopping Services
For a quick way to start up all containers(Web, API and Platform) you can simply run:
To stop and remove all services:
Web Application
To build the web application:
To run the web application:
API
To build the API:
To run the API:
Platform
To build the platform:
To run the platform:
Port Usage
The applications use the following ports by default:
Web Application: 3000
API: 4200
Platform: 3025
Ensure these ports are available on your system. If you need to use different ports, you can modify the port mappings in the package.json file locally.
For more detailed information about Docker usage, refer to the official Docker documentation.
Last updated