Files
rowy/README.md

109 lines
4.4 KiB
Markdown
Raw Normal View History

2021-09-24 23:22:52 +10:00
<p align="center">
2021-09-28 20:33:56 +10:00
<img src="src/assets/logo-sticker.svg" alt="Rowy" height="69" />
2021-09-24 23:22:52 +10:00
</p>
2021-06-23 13:39:07 +10:00
<h1 align="center">
2021-09-24 23:22:52 +10:00
✨ GCP as easy as ABC ✨ <br>
2021-06-23 13:39:07 +10:00
</h1>
<h3 align="center">
2021-09-24 23:22:52 +10:00
Build on Google Cloud Platform in minutes
2021-06-23 13:39:07 +10:00
</h3>
2021-09-24 15:43:02 +10:00
<p align="center">
2021-09-28 20:33:56 +10:00
Manage Firestore data in a spreadsheet-like UI, write Cloud Functions effortlessly in the browser, and connect to your favorite third party platforms such as SendGrid, Twilio, Algolia, sSack and more.
2021-09-24 15:43:02 +10:00
</p>
2021-09-24 23:22:52 +10:00
<div align="center">
2021-09-24 15:43:02 +10:00
2021-09-26 15:12:30 +10:00
[![Discord](https://img.shields.io/discord/853498675484819476?color=%234200FF&label=Chat%20with%20us&logo=discord&logoColor=%23FFFFFF&style=for-the-badge)](https://discord.com/invite/B8yAD5PDX4)
2021-09-28 20:33:56 +10:00
[![Twitter Follow](https://img.shields.io/twitter/follow/rowyio?color=%234200ff&logo=twitter&logoColor=%23fff&style=for-the-badge)](https://twitter.com/rowyio)
2021-09-24 23:22:52 +10:00
<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/B8yAD5PDX4"><b>Discord</b></a> •
2021-09-28 20:33:56 +10:00
<a href="https://twitter.com/rowyio"><b>Twitter</b></a>
</p>
2021-09-26 15:12:30 +10:00
2021-09-28 20:33:56 +10:00
[![License](https://img.shields.io/github/license/rowyio/rowy?style=for-the-badge)](https://github.com/rowyio/rowy/blob/main/LICENSE)
[![Last commit](https://img.shields.io/github/last-commit/rowyio/rowy/rc?style=for-the-badge)](https://github.com/rowyio/rowy/commits/rc)
[![GitHub stars](https://img.shields.io/github/stars/rowyio/rowy?style=for-the-badge)](https://github.com/rowyio/rowy/stargazers/)
2021-09-26 15:12:30 +10:00
2021-09-28 20:33:56 +10:00
</div>
2020-10-04 15:44:18 +11:00
2021-09-28 20:33:56 +10:00
<img width="100%" 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" />
2020-10-04 15:44:18 +11:00
2021-09-28 20:33:56 +10:00
## Quick try
2021-08-05 03:05:52 +10:00
2021-09-26 15:12:30 +10:00
<p>Set up Rowy on your Google Cloud Platform project with this one-click deploy button.<br/><br/>
2021-09-24 09:40:37 +10:00
<a href="https://deploy.cloud.run/?git_repo=https://github.com/rowyio/rowyRun.git" target="_blank">
2021-09-26 15:12:30 +10:00
<img width="300" src="https://storage.googleapis.com/cloudrun/button.png" alt="One Click Deploy"
2021-09-24 09:40:37 +10:00
title="One Click Deploy" width="250" /></a>
</p>
2020-10-04 15:44:18 +11:00
2021-09-28 20:33:56 +10:00
## Documentation
2021-09-28 11:36:46 +10:00
2021-09-28 20:33:56 +10:00
You can find the full documentation with how-to guides
[here](http://docs.rowy.io/).
2021-09-28 20:33:56 +10:00
## Features
2021-09-26 15:12:30 +10:00
2021-09-28 11:36:46 +10:00
### Powerful spreadsheet interface for Firestore
2021-09-26 15:12:30 +10:00
2021-09-28 11:36:46 +10:00
- CRUD operations
- Sort and filter by row values
- Lock, Freeze, Resize, Hide and Rename columns
- Multiple views for the same collection
- Bulk import or export data - csv, json
### Rich and flexible data fields
2021-09-28 20:33:56 +10:00
2021-09-28 11:36:46 +10:00
- [30+ fields supported](https://docs.rowy.io/field-types/supported-fields)
- Basic types: Short Text, Long Text, Email, Phone, URL…
- Custom UI pickers: Date, Checkbox, Single Select, Multi Select…
- Uploaders: Image, File
- Rich Editors: JSON, Code, Rich Text (HTML)
2021-09-26 15:12:30 +10:00
- Data validation, default values, required fields
2021-09-28 11:36:46 +10:00
- Action field: Clickable trigger for any Cloud Function
- Derivative field: Populate a cell with value derived from your database,
2021-09-28 20:33:56 +10:00
npm modules, api calls - called on field level triggers
2021-09-28 11:36:46 +10:00
- Aggregate field: Populate cell with value aggregated from the rows sub-table
2021-09-26 15:12:30 +10:00
2021-09-28 11:36:46 +10:00
### Collaborate with your team
- Granular table-level and field-level permission control
with custom user roles
- Built in user management
- Customizable views for different user roles
### Supercharge your database with cloud functions
- Effortless build cloud functions right in the browser
- Connect to your favourite tools: SendGrid, Algolia, Twilio, Bigquery and more
- Integrations with external services
2021-09-28 20:33:56 +10:00
- Connect Table uses Algolia to get a snapshot of another tables row values
- Connect Service uses any HTTP endpoint to get a cell value
2021-09-28 11:36:46 +10:00
2021-09-28 20:33:56 +10:00
## Install
Set up Rowy on your Google Cloud project with this one-click deploy button.
[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run/?git_repo=https://github.com/rowyio/rowyRun.git)
The one-click deploy makes the process of setting up easy with a step by step
guide and ensures your project is setup correctly.
2021-09-28 11:36:46 +10:00
2021-09-28 20:33:56 +10:00
It deploys [Rowy Run](https://github.com/rowyio/rowyrun), 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.
2021-09-26 15:12:30 +10:00
2021-09-28 20:35:16 +10:00
Alternatively, you can manually install by
[following this guide](https://docs.rowy.io/setup/install).
2021-09-26 15:12:30 +10:00
2021-09-28 20:33:56 +10:00
## Join our community
2021-09-24 09:40:37 +10:00
We would love to connect and hear what you think!
2021-09-24 09:40:37 +10:00
- [Discord](https://discord.gg/B8yAD5PDX4)
- [Twitter](https://twitter.com/rowyio)
- [Email](mailto:rowy.io)