debdutgoswami / lenzo

Lenzo is an online canvas application which streams users mouse position using sockets.

Real-time Low Bandwidth Drawing Board ✏️

It helps people to share own sketches Real-time.

Built over Socket ❤️

Report Bug · Request Feature

---

Features

1. Real-time

2. Low Bandwidth

3. Shareable Room Link

4. Adjustable Brush Size

---

Contributing

1. Clone the repository

   git clone [e-mail]:debdutgoswami/lenzo.git
   cd lenzo/

2. Create a separate branch for each feature

   git checkout -b <branch-name>

3. Make your changes

4. Create a Pull Request. Follow the PR guidelines

Note

Before starting with your day's development, perform a pull from the develop branch

git pull origin develop

---

Running Backend ONLY

1. Go to docker/backend

   cd docker/backend

2. Execute the run-server.sh

   chmod +x run-server.sh
   ./run-server.sh

   NOTE: If you are on Windows system, then you need to manually execute the run-server.sh commands without sudo

---

API Documentation

Once you have your backend up and running successfully, simply go to /docs to look into the API documentations. Furthermore, you can go to /playground to test out those APIs.

---

Running Client

1. Go to src/client

   cd src/client

2. Copy the contents of example.env.development.local to .env.development.local

   cp config/example.env.development.local .env.development.local

3. Start the client

   npm start

Custom Environment Docs

• https://create-react-app.dev/docs/adding-custom-environment-variables/