Description

An app to interact with the “Litter Robot”, by Whisker.

This app uses Python and FastAPI (with Web Sockets) as a backend wrapper around @natekspencer’s pylitterbot library. The frontend is built using SvelteKit, TailwindCSS, and DaisyUI.

Inspired by @natekspencer’s pylitterbot.

Getting Started

Clone and navigate to the the repository.

git clone https://engageintellect/litterbot
cd litterbot

Configure environment variables.

cp /server/.env.example /server/.env

Note: You will need to get your Litter Robot’s username and password credentials from the Whisker app.

cp /client/.env.example /client/.env

Note: Be sure to update the example values with your own.

Server

Configure and run backend.

cd server
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python main.py

Client

Configure and run client.

cd client
pnpm i
pnpm run dev --host