Skip to content

Code and file structure overview

Jump to bottom
Rishabh Poddar edited this page Sep 24, 2020 · 6 revisions

The below information is based on version 2.4.0

.circleci/: This contains the CircleCI config for running tests. In this folder, the tests start from doTests.sh which runs all the unit tests for the core with MySQL and MongoDB - one database for each type of plugin interface. The tests run whenever a dev tag is added to a commit. Dev tags have the format of dev-vX.Y.Z where X.Y.Z is the version of the core in that commit.

cli/: This folder contains the java source code for the SuperTokens CLI. The important parts in supertokens-core/cli/src/main/java/io/supertokens/cli/:

  • Main.java: Where the program starts.
  • cliOptionsParsers: Contains the class that parses the CLI arguments and makes it easily queriable by other parts of the source code
  • commandHandler: Contains handlers for each type of command that the CLI accepts - supertokens <command>.
  • commandHandler/CommandHandler.java: The abstract class that's inherited from for each command.

downloader/: TODO

Clone this wiki locally