Skip to content

Overview: Installing CodeSee in your project

This section describes how to install CodeSee into your project. The instructions assume you have an existing project that you want to add CodeSee to.

Following these instructions, you will:

  1. Install two npm packages.
  2. Configure Babel so that CodeSee instruments your code when running in development.
  3. Rebuild and run your app locally.

Install the CodeSee package in your JavaScript or TypeScript app

In the terminal, run the install command for your package manager:

npm install --save-dev @codesee/[email protected] @codesee/[email protected]
yarn add --dev @codesee/[email protected] @codesee/[email protected]

Configure your project for CodeSee

Follow the links below to set up CodeSee for your specific project environment:

Or, select generic setup if you use Typescript with Babel, or another framework not listed above:

Rebuild and run your app locally

Rebuild your app, wait a few seconds, and you should see the CodeSee button towards the top right of your screen. Congrats, you're ready to start using CodeSee!

Next steps