Getting Started

Orbit is an innovative platform layer built for the Internet Computer Protocol (ICP) and designed to extend to other blockchains. Follow this guide to set up and start developing with Orbit.

Prerequisites

Before you begin, ensure you have the following installed:

Rust Toolchain: Install from rust-lang.org.
DFX: Install the DFINITY Canister SDK by following the Internet Computer documentation.
Node.js: Download and install from nodejs.org.
pnpm: Install globally using npm:
Terminal window
```
npm install -g pnpm
```

Step 1: Clone the Orbit Repository

Start by cloning the Orbit repository from GitHub:

git clone https://github.com/dfinity/orbit.git
cd orbit

Step 2: Install Dependencies

Use pnpm to install the project dependencies:

pnpm install

Step 3: Set Up the Development Environment

Run the helper script provided by Orbit to configure the development environment:

./orbit

This script initializes the necessary settings for your environment.

Step 4: Start the Local Development Server

Start the Internet Computer replica in the background:
Terminal window
```
dfx start --clean --pocketic --host 127.0.0.1:4943
```
Deploy the canisters to the local replica:
Terminal window
```
dfx deploy
```
Navigate to the wallet application directory:
Terminal window
```
cd apps/wallet
```
Start the development server:
Terminal window
```
pnpm dev
```
Open your browser and go to http://localhost:3000 to access the Orbit wallet interface.

Step 5: Explore the Codebase

Here’s a quick overview of the Orbit project structure:

Core Logic: Located in the core directory.
Wallet Frontend: Found in the apps/wallet directory.
Shared Libraries: Available in the libs directory.

Step 6: Contribute to Orbit

If you’d like to contribute:

Read the HACKING.md file for contribution guidelines.
Ensure your code follows the project’s coding standards and includes tests.

Resources

You’re now ready to develop and contribute to Orbit! 🚀