mirror of
https://github.com/rowyio/rowy.git
synced 2025-12-16 03:37:53 +01:00
145 lines
11 KiB
HTML
145 lines
11 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">rowy</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> rowy </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p align="center">
|
||
<img src="src/assets/logo-sticker.svg" alt="Rowy" height="69" />
|
||
</p>
|
||
|
||
<h1 align="center">
|
||
✨ Data x Code ✨ <br/>
|
||
</h1>
|
||
<h3 align="center">
|
||
Modern Backend Stack
|
||
</h3>
|
||
<p align="center">
|
||
Forget CLIs, configs, and DevOps. Focus on building your apps with a platform designed for developer productivity. Your production database (Firestore) in an Airtable-like UI with full coding extensibility via Cloud Functions visually in the browser.
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
<p><a href="https://discord.gg/fjBugmvzZP"><img src="https://img.shields.io/discord/853498675484819476?color=%234200FF&label=Chat%20with%20us&logo=discord&logoColor=%23FFFFFF&style=for-the-badge" alt="Discord"></a></p>
|
||
<p align="center">
|
||
<a href="http://www.rowy.io"><b>Website</b></a> •
|
||
<a href="http://docs.rowy.io"><b>Documentation</b></a> •
|
||
<a href="https://discord.gg/fjBugmvzZP"><b>Discord</b></a> •
|
||
<a href="https://twitter.com/rowyio"><b>Twitter</b></a>
|
||
</p>
|
||
|
||
<p><a href="https://github.com/rowyio/rowy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/rowyio/rowy" alt="License"></a>
|
||
<a href="https://github.com/rowyio/rowy/commits/rc"><img src="https://img.shields.io/github/last-commit/rowyio/rowy/rc" alt="Last commit"></a>
|
||
<a href="https://github.com/rowyio/rowy/stargazers/"><img src="https://img.shields.io/github/stars/rowyio/rowy" alt="GitHub stars"></a></p>
|
||
</div>
|
||
<img width="100%" src="https://user-images.githubusercontent.com/307298/157184506-f94f3f5b-e6d3-49df-9a2c-f665511883f2.png" />
|
||
|
||
|
||
<a href="#live-demo" id="live-demo" style="color: inherit; text-decoration: none;">
|
||
<h2>Live Demo</h2>
|
||
</a>
|
||
<p>💥 Check out the <a href="https://demo.rowy.io/">live demo</a> of Rowy 💥 </p>
|
||
|
||
<a href="#quick-deploy" id="quick-deploy" style="color: inherit; text-decoration: none;">
|
||
<h2>Quick Deploy</h2>
|
||
</a>
|
||
<p>Set up Rowy on your Google Cloud Platform project with this easy deploy button.</p>
|
||
<p><a href="https://deploy.rowy.app/"><img src="https://deploy.cloud.run/button.svg" alt="Run on Google Cloud"></a></p>
|
||
<p><a href="https://deploy.rowy.app/">https://deploy.rowy.app/</a></p>
|
||
|
||
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
|
||
<h2>Documentation</h2>
|
||
</a>
|
||
<p>You can find the full documentation with how-to guides and templates
|
||
<a href="http://docs.rowy.io/">here</a>.</p>
|
||
|
||
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
|
||
<h2>Features</h2>
|
||
</a>
|
||
<p><a href="https://user-images.githubusercontent.com/307298/157185793-f67511cd-7b7b-4229-9589-d7defbf7a63f.mp4">https://user-images.githubusercontent.com/307298/157185793-f67511cd-7b7b-4229-9589-d7defbf7a63f.mp4</a></p>
|
||
<!-- <img width="85%" src="https://firebasestorage.googleapis.com/v0/b/rowyio.appspot.com/o/publicDemo%2FRowy%20Website%20Video%20GIF%20Small.gif?alt=media&token=3f699a8f-c1f2-4046-8ed5-e4ff66947cd8" />
|
||
-->
|
||
|
||
<a href="#powerful-spreadsheet-interface-for-firestore" id="powerful-spreadsheet-interface-for-firestore" style="color: inherit; text-decoration: none;">
|
||
<h3>Powerful spreadsheet interface for Firestore</h3>
|
||
</a>
|
||
<ul>
|
||
<li>CRUD operations</li>
|
||
<li>Sort and filter by row values</li>
|
||
<li>Lock, Freeze, Resize, Hide and Rename columns</li>
|
||
<li>Multiple views for the same collection</li>
|
||
<li>Bulk import or export data - csv, json</li>
|
||
</ul>
|
||
|
||
<a href="#automate-with-cloud-functions-and-ready-made-extensions" id="automate-with-cloud-functions-and-ready-made-extensions" style="color: inherit; text-decoration: none;">
|
||
<h3>Automate with cloud functions and ready made extensions</h3>
|
||
</a>
|
||
<ul>
|
||
<li>Effortlessly build cloud functions on field level triggers right in the browser<ul>
|
||
<li>Use any NPM modules or APIs</li>
|
||
</ul>
|
||
</li>
|
||
<li>Connect to your favourite tool with pre-built extensions or create your own<ul>
|
||
<li>SendGrid, Algolia, Twilio, Bigquery and more</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<a href="#rich-and-flexible-data-fields" id="rich-and-flexible-data-fields" style="color: inherit; text-decoration: none;">
|
||
<h3>Rich and flexible data fields</h3>
|
||
</a>
|
||
<ul>
|
||
<li><a href="https://docs.rowy.io/field-types/supported-fields">30+ fields supported</a><ul>
|
||
<li>Basic types: Short Text, Long Text, Email, Phone, URL…</li>
|
||
<li>Custom UI pickers: Date, Checkbox, Single Select, Multi Select…</li>
|
||
<li>Uploaders: Image, File</li>
|
||
<li>Rich Editors: JSON, Code, Rich Text (HTML)</li>
|
||
</ul>
|
||
</li>
|
||
<li>Data validation, default values, required fields</li>
|
||
<li>Action field: Clickable trigger for any Cloud Function</li>
|
||
<li>Aggregate field: Populate cell with value aggregated from the row’s sub-table</li>
|
||
<li>Connect Table: Get snapshot of data from another data table using Algolia</li>
|
||
<li>Connect Service: Get data from any HTTP endpoint</li>
|
||
</ul>
|
||
|
||
<a href="#collaborate-with-your-team" id="collaborate-with-your-team" style="color: inherit; text-decoration: none;">
|
||
<h3>Collaborate with your team</h3>
|
||
</a>
|
||
<ul>
|
||
<li>Granular table-level and field-level permission control<br>with custom user roles</li>
|
||
<li>Built in user management</li>
|
||
<li>Customizable views for different user roles</li>
|
||
</ul>
|
||
|
||
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
|
||
<h2>Install</h2>
|
||
</a>
|
||
<p>Set up Rowy on your Google Cloud project with this one-click deploy button. Your data and cloud functions stay on your own Firestore/GCP.</p>
|
||
<p><a href="https://deploy.rowy.app/"><img src="https://deploy.cloud.run/button.svg" alt="Run on Google Cloud"></a></p>
|
||
<p>The one-click deploy makes the process of setting up easy with a step by step
|
||
guide and ensures your project is setup correctly.</p>
|
||
<p>It deploys <a href="https://github.com/rowyio/rowyrun">Rowy Run</a>, an open-source Cloud
|
||
Run instance that operates exclusively on your GCP project. So we never have
|
||
access to your service account or any of your data.</p>
|
||
<p>Alternatively, you can manually install by
|
||
<a href="https://docs.rowy.io/setup/install">following this guide</a>.</p>
|
||
|
||
<a href="#roadmap" id="roadmap" style="color: inherit; text-decoration: none;">
|
||
<h2>Roadmap</h2>
|
||
</a>
|
||
<p><a href="https://demo.rowy.io/table/roadmap">View our roadmap</a> on Rowy - Upvote, downvote, share your thoughts!</p>
|
||
<p>If you'd like to propose a feature, submit an issue <a href="https://github.com/rowyio/rowy/issues/new?assignees=&labels=&template=feature_request.md&title=">here</a>.</p>
|
||
|
||
<a href="#support-the-project" id="support-the-project" style="color: inherit; text-decoration: none;">
|
||
<h2>Support the project</h2>
|
||
</a>
|
||
<ul>
|
||
<li>Join a community of developers on <a href="https://discord.gg/fjBugmvzZP">Discord</a> and share your ideas/feedback 💬</li>
|
||
<li>Follow us on <a href="https://twitter.com/rowyio">Twitter</a> and help <a href="https://twitter.com/intent/tweet?text=Check%20out%20@rowyio%20-%20It%27s%20like%20an%20open-source%20Airtable%20for%20your%20database,%20but%20with%20a%20built-in%20code%20editor%20for%20cloud%20functions%20to%20run%20on%20data%20CRUD!%0a%0aEsp%20if%20building%20on%20@googlecloud%20and%20@Firebase%20stack,%20it%20is%20the%20fastest%20way%20to%20build%20your%20product.%20Live%20demo:%20https://demo.rowy.io">spread the word</a> 🙏</li>
|
||
<li>Give us a star to this Github repo ⭐️</li>
|
||
<li>Submit a PR. Take a look at our <a href="https://github.com/rowyio/rowy/blob/main/CONTRIBUTING.md">contribution guide</a> and get started with <a href="https://github.com/rowyio/rowy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first issues</a>.</li>
|
||
</ul>
|
||
|
||
<a href="#help" id="help" style="color: inherit; text-decoration: none;">
|
||
<h2>Help</h2>
|
||
</a>
|
||
<ul>
|
||
<li>Live chat support on <a href="https://discord.gg/fjBugmvzZP">Discord</a></li>
|
||
<li><a href="mailto:hello@rowy.io">Email</a></li>
|
||
</ul>
|
||
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/globalScope.html">global<wbr/>Scope</a></li><li class=" tsd-kind-module"><a href="modules/tableScope.html">table<wbr/>Scope</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html> |