https://github.com/graasp/graasp-app-excalidraw
https://github.com/graasp/graasp-app-excalidraw
collaboration learning sketching
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/graasp/graasp-app-excalidraw
- Owner: graasp
- License: agpl-3.0
- Created: 2022-09-22T07:52:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T17:45:25.000Z (6 months ago)
- Last Synced: 2024-10-24T01:52:25.032Z (6 months ago)
- Topics: collaboration, learning, sketching
- Language: TypeScript
- Homepage:
- Size: 5.7 MB
- Stars: 3
- Watchers: 8
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Graasp App Excalidraw
This repository hosts the code for Excalidraw's integration into the Graasp ecosystem.
Excalidraw is an open-source web drawing application. Try it directly with the [original Excalidraw app](https://excalidraw.com/)!
## Development
### Local setup
To work with Graasp apps locally, follow the official Graasp documentation.
To get started with this app, clone this repo. You will need to add a dotenv file `.env.development`.
```dotenv
VITE_PORT=3335 # The port on which you would like to serve the app.
VITE_API_HOST=localhost # The hostname (localhost for local dev)
VITE_MOCK_API=false # Mock the API by default (overriden by yarn dev:mock)
VITE_GRAASP_APP_KEY=82582612-92aa-408f-bfe9-0d202414a3b6 # The app key in your local Graasp instance.
VITE_VERSION=latest # The version of your app (not important for development)
```
Install the dependencies by running [yarn](https://yarnpkg.com/):
```bash
yarn
```
And finally start the app. To serve it within your local Graasp instance:
```bash
yarn dev
```
And to serve it with a mocked API (see [the documentation](https://graasp.github.io/docs/category/apps-development)):
```bash
yarn dev:mock
```
You can find a lot of informations on the [developer documentation of Excalidraw](https://docs.excalidraw.com/).
## How to use
To use this app, you can either run it locally which will give you direct access to an excalidraw canvas or fit it inside a Graasp activity as it is already deployed.
Excalidraw's documentation can be found [here](https://github.com/excalidraw/excalidraw#documentation), and a description of the tools is available on canvas by clicking on the ? button.
## Example
Below you can find a screenshot of the app inside the Graasp Builder view.
## What's next?
For future versions, here is a list of features to be implemented and points to be optimized:
- Enabling collaboration
- Templates
- Library
- More options for exports