Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/engageintellect/litterbot
An app for easy control over whisker's litter robot 4 using Python, Sveltekit, WebSockets, FastAPI, and Ubuntu.
https://github.com/engageintellect/litterbot
api daisyui fastapi litter-robot python robotics svelte sveltekit tailwindcss typescript ubuntu uvicorn vercel websockets
Last synced: 10 days ago
JSON representation
An app for easy control over whisker's litter robot 4 using Python, Sveltekit, WebSockets, FastAPI, and Ubuntu.
- Host: GitHub
- URL: https://github.com/engageintellect/litterbot
- Owner: engageintellect
- Created: 2024-04-23T05:41:34.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T02:17:35.000Z (8 months ago)
- Last Synced: 2024-10-26T18:46:24.054Z (about 2 months ago)
- Topics: api, daisyui, fastapi, litter-robot, python, robotics, svelte, sveltekit, tailwindcss, typescript, ubuntu, uvicorn, vercel, websockets
- Language: Svelte
- Homepage: https://litterbot.vercel.app
- Size: 7.39 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# litterbot
## Description
An app to interact with the "Litter Robot", by [Whisker](https://www.litter-robot.com/litter-robot-4.html).
[](https://litterbot.vercel.app)
This app uses Python and FastAPI (with Web Sockets) as a backend wrapper around [@natekspencer](https://github.com/natekspencer)'s [pylitterbot](https://github.com/natekspencer/pylitterbot) library. The frontend is built using [SvelteKit](https://kit.svelte.dev/), [TailwindCSS](https://tailwindcss.com), and [DaisyUI](https://daisyui.com).
Inspired by [@natekspencer](https://github.com/natekspencer)'s [pylitterbot](https://github.com/natekspencer/pylitterbot).
## Getting Started
Clone and navigate to the the repository.
```bash
git clone https://engageintellect/litterbot
cd litterbot
```
### Configure environment variables.
```bash
cp /server/.env.example /server/.env
```
**Note:** You will need to get your Litter Robot's username and password credentials from the Whisker app.
```bash
cp /client/.env.example /client/.env
```
**Note:** Be sure to update the example values with your own.
### Server
Configure and run backend.
```bash
cd server
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python main.py
```
### Client
Configure and run client.
```bash
cd client
pnpm i
pnpm run dev --host
```