Skyframe Documentation

Scripts

Scripts

When you generate a new project with Skyframe you get a set of default scripts that will help you start coding your new application.

Monorepo scripts

These are all the commands you can run from the root directory.

  • yarn bootstrap: This command will install all the dependencies of the monorepo and link applications with internal dependency.
  • yarn build: This command will build all the applications in the monorepo.
  • yarn test: Will run all the test cases in the monorepo.
  • yarn pr: This command will build and test all the apps. You can run this command before pushing a branch in order to make sure nothing is broken.
  • yarn commit: Stages every file and runs commitizen. This command will automatically create a commit that follows the conventional commits standards.

Application scripts

These are all the commands you can run from an Application directory.

  • yarn start: Serves the application and expose a port for you to use.
  • yarn test: Runs all the tests for the current application.

Database scripts

We have a few commands specifically for applications that handle database queries, like a NestJS application.

  • yarn create-db: Creates a new database based on environment variables.
  • yarn delete-db: Deletes the database.
  • yarn restart-db: Erases all the information from the database.
  • yarn add-migration: Generates a new migration file.
  • yarn add-seeders: Generates a new seeder file.
  • yarn migrations: Runs all the missing migrations.
  • yarn seeders: Runs all the missing seeders.