Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 2.26 KB

getting-started.md

File metadata and controls

87 lines (67 loc) · 2.26 KB

Getting Started with Juno

Welcome to the Juno platform! This guide will help you get set up and start using Juno to develop your applications.

Prerequisites

Before you begin, ensure you have the following software installed on your machine:

  • Node.js (version 18 or higher)
  • npm (version 6 or higher)
  • Git

Setup

  1. Clone the Repository:

    git clone https://github.com/cloudoperators/juno.git
cd juno

  2. Install Dependencies:

    npm install -f

  3. Setup Husky:

    npm run prepare

  4. Available Turbo Commands:

    • Build:

      npm run turbo build

    • Lint:

      npm run turbo lint

    • Test:

      npm run turbo test

    • Dev:

      npm run turbo dev

    • Clean:

      npm run turbo clean

    • Pkg: To run a specific app or package, start by identifying the name in the package.json file located within the relevant app folder. Once you have the name, use it in the following command. For example, to run the exampleapp use @cloudoperators/juno-app-example as in the command below:

      npm run pkg @cloudoperators/juno-app-example

    • Generator:Package The npm run generate:package command is used to generate a new package in a project. When running this command, you need to provide a name for the package that starts with @cloudoperators/juno-.

      npm run generate:package @cloudoperators/juno-NAME-OF-YOUR-PACKAGE

    • Generator:App The npm run generate:app command is used to generate a new app in a project. When running this command, you need to provide a name for the app that starts with @cloudoperators/juno-.

      npm run generate:app @cloudoperators/juno-NAME-OF-YOUR-PACKAGE

You can also install Turbo globally and run the commands directly:

npm install -g turbo
turbo build

Or just use npx:

npx turbo build

We emphasize using Turbo commands for most tasks to ensure consistency and efficiency. The Juno project follows a monorepo pattern, facilitating shared dependencies and streamlined development across multiple packages.