@tliuhr/backroad v1.5.6
Backroad
Backroad provides a simple streamlit-like API and ships with several commonly used components out of the box like form inputs, tables and LLMs. Powered by a top-to-bottom re-run based flow, it allows you to quickly put together applications with a very easy-to-understand interface.
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed a relatively recent version of Node.JS
Installing Backroad
To install Backroad, follow these steps:
npx degit sudomakes/trybackroad trybackroad
cd trybackroad
npm i
npm run dev
Backroad Example
Here's what a sample backroad script looks like
const [photo] = br.fileUpload({ label: 'Pick Image' });
if (photo) {
br.write({ body: '# Greyscale image' });
const image = await Jimp.read(photo.filepath);
image.greyscale().getBase64(Jimp.AUTO, (err, res) => {
br.image({ src: res, width: 600 });
});
}
And this is the output you will get in the browser:
As you can probably notice, it takes a relatively small amount of code to get started building and prototyping your ideas with Backroad. To learn more about backroad components and concepts, refer the docs
Contributing to Backroad
To contribute to Backroad, follow these steps:
You can refer to the contribution guide which has some helpful instructions on how to get started with contributing to Backroad.
Alternatively see the GitHub documentation on creating a pull request.
Contact
If you want to reach out for anything related to Backroad, you may send an email to contact@sudomakes.art
Links
Website & Documentation : backroad.sudomakes.art
Link to the NPM Package: @backroad/backroad
Easiest way to get started with backroad: sudomakes/trybackroad
License
This project uses the Fair Source license.
9 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago