# Development

Photo Sphere Viewer is developped in TypeScript (opens new window) and SASS (opens new window). The repository is a Turborepo (opens new window) mono-repo containing the core package as well as official adapters and plugins. The building process is based on tsup (opens new window) (toolkit based on esbuild) with a bunch of customizations. The documentation is created with VuePress (opens new window) and TypeDoc (opens new window). Files are linted with ESLint (opens new window) and Stylelint (opens new window). The (few) unit tests are executed with Mocha (opens new window). You will need Node.js 18 (opens new window).

# Commands

  • launch the dev server with npm run serve
  • launch the documentation with npm run doc:serve
  • register all package for npm link with npm run npm-link
  • execute the linters with npm run lint
  • execute the unit tests with npm run test
  • build all the packages with npm run build
  • build the documentation with npm run doc:build