@urbit/cra-template

Getting Started with Create Urbit App

This project was bootstrapped with Create React App. It allows you to get started quickly developing a React/Typescript app on top of Urbit. It assumes you are running a fakezod at localhost:8080. Follow the guide here to set up your development environment.

You need to run |cors-approve 'http://localhost:3000' to allow your app to communicate with your fakezod.

The default implementation of this app simply watches for chat messages to come in and, when clicked, responds to the same channel with a quote of the message.

It should give you an idea of how to create an Urbit app using react with zustand for state management with Urbit's HTTP API for communication and the API package for utilities and TypeScript help.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.