Keyshade Alpha is launching April 30th 5:00 PM IST
Join our Launch Party
keyshade docs
GithubDiscordReddit
  • 👋What is keyshade?
  • Getting Started
    • Introduction
    • Adding your first secret and variable
    • Installing the CLI
    • Setting up your profile
    • Add keyshade to your project
    • Running your app
  • CLI
    • Introduction
    • Profile
    • Init
    • Workspace
    • Project
    • Environment
    • Run
    • Scan
  • 🥰CONTRIBUTING TO KEYSHADE
    • Summary
    • Design of our code
      • Organization of code
      • API
      • CLI
      • Web
      • Integrations
    • Prerequisites
    • Environment Variables
    • Setting things up
    • Running things locally
      • Running the API
      • Running the Web
      • Running the Platform
      • Running the CLI
      • API Testing
      • Docker Support
  • Internals
    • Architecture of keyshade
    • How the CLI works
Powered by GitBook
On this page
  • Running the Platform
  • Testing your code
  • Viewing the Platform App

Was this helpful?

Edit on GitHub
  1. CONTRIBUTING TO KEYSHADE
  2. Running things locally

Running the Platform

Get to know how you can run the platform app!

PreviousRunning the WebNextRunning the CLI

Last updated 7 months ago

Was this helpful?

Running the Platform

The Platform App resides in the apps/platform directory. It is powered by NextJS and TypeScript. To run the Platform App locally, do the following:

  • In the project root, run:

pnpm i

Next set up the platform app for development with:

pnpm dev:platform
  • Or cd into apps/platform and run:

pnpm dev

Testing your code

We use Jest for testing. Run the tests when unit testing, or mock testing the platform app separately from the rest of the project.

  • To run tests in the root, use this command:

pnpm test:platform

Viewing the Platform App

  • You can view the platform app by opening the URL in a browser.

🥰
http://localhost:3025