Skip to main content
This guide will help you get Skiff Mail running locally on your machine quickly.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (v16 or higher)
  • Git

​
Installation

1

Install Yarn

First, install Yarn if you don’t have it already.
2

Clone the repository

Clone the Skiff apps repository:
git clone https://github.com/skiff-org/skiff-apps.git
cd skiff-apps/
3

Set Yarn version

Set Yarn to version 3.0+ using Yarn Berry:
yarn set version berry
4

Install dependencies

Install all project dependencies:
yarn
This will install dependencies for all workspaces in the monorepo.
5

Build shared libraries

Build the shared libraries that the applications depend on:
yarn build:lib
This builds the libraries in the correct order:
  • skiff-utils
  • skiff-mail-protos
  • skiff-graphql
  • skiff-crypto
  • skiff-front-graphql
  • skiff-front-utils
6

Start the development server

Start the Skiff Mail development server:
yarn dev
The application will be available at http://localhost:4200/mail/inbox

​
What’s Next?

You now have Skiff Mail running locally with mock data. The app currently uses mock data - API access may be added in the future.

Local Development

Learn about the development workflow and available commands

Architecture

Understand the Skiff monorepo structure and architecture

Build docs developers (and LLMs) love

Get started for freeTalk to us