Developer Docs & Contributing

This section provides technical documentation for developers who want to understand Onlook's architecture, contribute to the project, or extend its functionality.

Overview

Onlook is structured as a monorepo with several interconnected apps and packages, primarily built using Next.js, React, TypeScript, and Vite.

Contributing to Onlook

We welcome contributions to Onlook! This guide will help you get started with contributing to the project.

When contributing to this repository, please first discuss the change you wish to make via issues, Discord, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Running the project locally

You can build the project from source using instructions here.

Pull Request Process

1. To create a Pull Request (PR), create a fork of the project.