You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
success/README.md

51 lines
1.3 KiB
Markdown

<div align="center" style="display:flex;flex-direction:column;">
<a href="https://excalidraw.com">
<img src=".github/assets/logo.png" alt="" width="220px" height="202"/>
</a>
<h3>Excalidraw is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.</h3>
</div>
## Try it now
5 years ago
Go to https://excalidraw.com to start sketching
5 years ago
## Getting started
5 years ago
### Code Sandbox
5 years ago
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You can start coding instantly, and even send PRs from there!
5 years ago
### Local Installation
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Clone the repo
```bash
5 years ago
git clone https://github.com/excalidraw/excalidraw.git
```
Install all the dependencies
```bash
npm install
```
Run the project
```bash
npm run start
```
## Contributing
Pull requests are welcome. For major changes, please open an [issue](https://github.com/excalidraw/excalidraw/issues) first to discuss what you would like to change.
5 years ago
## Excalidraw is built using these awesome tools
- [React](https://reactjs.org/)
- [Rough.js](https://roughjs.com/)
The project is at its early days, there are some key [features](https://github.com/excalidraw/excalidraw/milestone/1) that we need to implement in order to make the application very useful.