Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (34 sloc) 3.05 KB

Quick Start

This document will guide you to get started with OpenCatapult.

The easiest way to get started and use OpenCatapult is by utilizing the released package. At the moment it is only available for Windows x64 platform. We have been planning to release the package for other platforms (Linux or Mac) as well in the future.

If you want to try OpenCatapult in the platforms other than Windows now, you could always build it yourself from the source code which you can get from our GitHub repository. This guide might be useful if you want to do it.

Prerequisites

The main OpenCatapult components require .NET Core 2.2 runtime installed on your machine. However, in this tutorial you will also need .NET Core 2.2 SDK because you will generate an ASP.NET Core MVC application later by using some .NET CLI commands.

If you don't have the SDK, please get the installer from the .NET download page. Please note that installing SDK will also include the runtime, so you don't have to install them twice.

After installing .NET Core, please make sure it is correctly installed on your machine by typing this command in a Command Prompt:

dotnet --info

If you get something like the screenshot below, it means you are good to go.

dotnet info

Get the released package

Please go to OpenCatapult release website and download the latest package available in the All Components box. As of this writing, the latest package is opencatapult-v1.0.0-beta4.1-win-x64.zip.

Run the components

Please follow these steps to run the OpenCatapult components:

  1. Extract the released package into a location on your machine, e.g. C:\OpenCatapult

  2. Open the location in Windows Explorer

  3. Right click the "run.bat" file, and select "Run as administrator". Click "Yes" on the confirmation dialog

Run as administrator User Access Control Confirmation

  1. Notice that it will open four new Command Prompt windows for each of the OpenCatapult component: API, Engine, CLI, and Web UI. Wait a minute for the process to complete, and find the windows for API and Web components and make sure they show as per screenshot below:

Run API Run Web

  1. Open your browser, and go to https://localhost:44300 to open the OpenCatapult Web UI

Browse Web

  1. In the login page, enter "admin@opencatapult.net" as the UserName, and "opencatapult" as the Password. If you are able to login, it means the components have been setup correctly.

Welcome

Next steps

As you have the OpenCatapult setup on your machine, you can start to explore more about it.

You can’t perform that action at this time.