Estuary: A Framework for Building Multimodal Low-Latency Real-Time Socially Interactive Agents

Homepage and Documentation

https://estuary-ai.github.io/

Basics

• Built with React + TailwindCSS
• main branch is for source code (modify this!)
• ghpages branch is only for the build for GitHub Pages

Prereqs

• npm --version = 10.2.4 (or higher?)
• node --version = 20.11.1 (or higher?)
• need git and a GitHub account!

Quick start

1. Clone repo!
2. cd into root directory that contains package.json. Make sure you're in the main branch
3. npm install to install all dependencies
4. npm install lucide-react to install icons
5. Make changes as you wish!
6. To preview your local changes on localhost:3000, run npm start
7. To push and deploy on GitHub Pages, run npm run deploy
8. Make sure to push your local changes to main branch as well!

Remarks on versions

• Currently using tailwindcss@3, in order to easily use tailwind.config.js(?)
• But in the future, preferably move to Next.js and use tailwindcss@4