Getting Started with Moose

Getting Started with Moose

Viewing typescript

switch to python

Run Docker

Open Docker Desktop if its not already running.
Don't have it installed? Download Docker here (opens in a new tab)

Create an Empty Moose Project

Terminal
npx create-moose-app@latest moose-github-analytics ts --empty

This Moose CLI helper function creates a new Moose app with the proper conventions for the basic directory structure. This includes an /app folder which contains the heart of your new Moose app. Each sub-folder hosts one type of Moose primitive.

  • cd into your Moose Project and Install Dependencies

    Terminal
    cd moose-github-analytics && npm install

    Run the Moose Development Server

    Terminal
    npm run dev
    Warning:

    You must be in your project directory in order to start the development server

    You should expect to see the following printed to your terminal:

    Congrats!

    You have set up a Moose instance at http://localhost:4000



    It provides the following infrastructure:

      • OLAP Database (Clickhouse) to store and analyze your data
      • Streaming Data Platform (Redpanda) to buffer and transform incoming data
      • Ingestion and Consumption APIs to get data in and out of your database

    As you develop, the dev server automatically updates with your latest changes, providing a real-time view of your Moose application locally.

    Open Project in IDE

    With VSCode, for example:

    Terminal
    code .
    (VSCode) Install Recommended Extensions

    Click 'Install' on the pop-up window located in the bottom right corner of the screen. Moose will automatically configure these extensions for you.