9e5de0c48e
This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like!  --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
110 lines
4.1 KiB
Markdown
110 lines
4.1 KiB
Markdown
<div alt style="text-align: center; transform: scale(.5);">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tldraw/tldraw/main/assets/github-hero-dark-draw.png" />
|
|
<img alt="tldraw" src="https://raw.githubusercontent.com/tldraw/tldraw/main/assets/github-hero-light-draw.png" />
|
|
</picture>
|
|
</div>
|
|
|
|
# tldraw
|
|
|
|
Welcome to the public monorepo for [tldraw](https://tldraw.com).
|
|
|
|
## What is tldraw?
|
|
|
|
tldraw is a collaborative digital whiteboard available at [tldraw.com](https://tldraw.com). Its editor, user interface, and other underlying libraries are open source and available in this repository. They are also distributed on npm. You can use tldraw to create a drop-in whiteboard for your product or as the foundation on which to build your own inifinite canvas applications.
|
|
|
|
Learn more at [tldraw.dev](https://tldraw.dev).
|
|
|
|
> **Note** This repo contains source code for the **current version** of tldraw. You can find the source for the original version [here](https://github.com/tldraw/tldraw-v1).
|
|
|
|
## Installation & Usage
|
|
|
|
To learn more about using tldraw in your React application, follow our guide [here](https://tldraw.dev/docs/ucg/installation) or see [this CodeSandbox](https://codesandbox.io/p/github/tldraw/tldraw-examples/main?file=%2FREADME.md).
|
|
|
|
```tsx
|
|
import { Tldraw } from '@tldraw/tldraw'
|
|
import '@tldraw/tldraw/editor.css'
|
|
import '@tldraw/tldraw/ui.css'
|
|
|
|
function TldrawExample() {
|
|
return <Tldraw />
|
|
}
|
|
```
|
|
|
|
## Local development
|
|
|
|
To run the local development server, first clone this repo.
|
|
|
|
Install dependencies:
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
Start the local development server:
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
Open the example project at `localhost:5420`.
|
|
|
|
### Examples
|
|
|
|
Our development server contains several examples that demonstrates different ways that you can customize tldraw or use its APIs. Each example is found in the [**apps/examples/src**](https://github.com/tldraw/tldraw/tree/main/apps/examples/src) folder.
|
|
|
|
- eg: `localhost:5420` for the basic example.
|
|
- eg: `localhost:5420/api` for the API example.
|
|
|
|
To learn more about using tldraw, [visit our docs](https://tldraw.dev).
|
|
|
|
## About this repository
|
|
|
|
### Top-level layout
|
|
|
|
This repository's contents is divided across four primary sections:
|
|
|
|
- `/apps` contains the source for our applications
|
|
- `/packages` contains the source for our public packages
|
|
- `/scripts` contains scripts used for building and publishing
|
|
- `/assets` contains icons and translations relied on by the app
|
|
|
|
### Applications
|
|
|
|
- `examples`: our local development / examples project
|
|
- `docs`: our docs site at [tldraw.dev](https://tldraw.dev)
|
|
- `vscode`: our [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode)
|
|
|
|
### Packages
|
|
|
|
- `editor`: the tldraw editor
|
|
- `ui`: the editor's user interface
|
|
- `tldraw`: the main tldraw package containing both the editor and the UI
|
|
- `primitives`: low-level primitives for working with vectors and geometry
|
|
- `tlschema`: shape definitions and migrations
|
|
- `tlsync-client`: a library for (locally) syncronizing editor instances
|
|
- `tlstore`: an in-memory reactive database
|
|
- `tlvalidate`: a validation library used for run-time validation
|
|
- `tlassets`: a library for working with tldraw's fonts and translations
|
|
- `file-format`: a library for working with tldraw's `.tldr` file format
|
|
- `utils`: low-level data utilities shared by other libraries
|
|
|
|
## Community
|
|
|
|
Have questions, comments or feedback? [Join our discord](https://discord.gg/rhsyWMUJxd) or [start a discussion](https://github.com/tldraw/tldraw/discussions/new).
|
|
|
|
## Contribution
|
|
|
|
Please see our [contributing guide](https://github.com/tldraw/tldraw/blob/main/CONTRIBUTING.md). Found a bug? Please [submit an issue](https://github.com/tldraw/tldraw/issues/new).
|
|
|
|
## Distributions
|
|
|
|
You can find tldraw on npm [here](https://www.npmjs.com/package/@tldraw/tldraw).
|
|
|
|
## License
|
|
|
|
The source code in this repository is licensed under Apache 2.0. The examples are licensed under MIT.
|
|
|
|
## Contact
|
|
|
|
Find us on Twitter at [@tldraw](https://twitter.com/tldraw) or email [hello@tldraw.com](mailto://hello@tldraw.com). You can also [join our discord](https://discord.gg/rhsyWMUJxd) for quick help and support.
|