Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rocicorp/replidraw


https://github.com/rocicorp/replidraw

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# Replidraw

A tiny Figma-like multiplayer graphics editor.

Built with [Replicache](https://replicache.dev), [Next.js](https://nextjs.org/),
[Pusher](https://pusher.com/), and [Postgres](https://www.postgresql.org/).

Running live at https://replidraw.herokuapp.com/.

# Prerequisites

1. [Get a Replicache license key](https://doc.replicache.dev/licensing)
2. Install PostgreSQL. On MacOS, we recommend using [Postgres.app](https://postgresapp.com/). For other OSes and options, see [Postgres Downloads](https://www.postgresql.org/download/).
3. [Sign up for a free pusher.com account](https://pusher.com/) and create a new "channels" app.

# To run locally

Get the Pusher environment variables from the ["App Keys" section](https://i.imgur.com/7DNmTKZ.png) of the Pusher App UI.

**Note:** These instructions assume you installed PostgreSQL via Postgres.app on MacOS. If you installed some other way, or configured PostgreSQL specially, you may additionally need to set the `PGUSER` and `PGPASSWORD` environment variables.

```
export DATABASE_URL=postgresql://:@localhost:/replidraw
export NEXT_PUBLIC_REPLICACHE_LICENSE_KEY=""
export NEXT_PUBLIC_PUSHER_APP_ID=
export NEXT_PUBLIC_PUSHER_KEY=
export NEXT_PUBLIC_PUSHER_SECRET=
export NEXT_PUBLIC_PUSHER_CLUSTER=

# Create a new database for Replidraw
psql -d postgres -c 'create database replidraw'

npm install
npm run dev
```