Screen Dawg

Getting Started

Welcome to the ScreenDawg deployment guide! 🐶 This guide will walk you through setting up and running your own instance of the ScreenDawg image upload app.

💡 This project is open source!
View the code and contribute on GitHub:
👉 github.com/DeimoLabs/ScreenDawg

⚙️ Requirements

Before getting started, make sure you have:

  • Node.js (v18+) installed
  • Git
  • A VPS, cloud instance, or local machine to run the server

📥 1. Clone the Repository

git clone https://github.com/DeimoLabs/ScreenDawg.git
cd ScreenDawg
Bash

📦 2. Install Dependencies

Install the required Node packages using npm:

npm install
Bash

🛠️ 3. Configure ScreenDawg

Rename the example config file and edit it to suit your environment:

Edit config.yaml with your preferred settings.

🚀 4. Start the App

To start the server, run:

npm start
Bash

By default, ScreenDawg runs on http://localhost:3000.
You can reverse proxy it with Nginx or run it behind Cloudflare Tunnel.

🖼️ 5. Upload and Share

You’re now running ScreenDawg!

  • Drag and drop or click to upload images.
  • Share the short link like yourdomain.com/abc123.jpg
  • Users are remembered with a local cookie (no accounts).