Files
rowy/README.md

117 lines
4.3 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-12-01 17:40:27 +05:30
✨ Modern Backend Stack ✨ <br/>
2021-06-23 13:39:07 +10:00
</h1>
<h3 align="center">
2021-12-01 17:40:27 +05:30
Build prototypes that scale 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-10-06 02:20:15 +11: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, Slack 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
2022-02-09 12:21:11 +11:00
[![Discord](https://img.shields.io/discord/853498675484819476?color=%234200FF&label=Chat%20with%20us&logo=discord&logoColor=%23FFFFFF&style=for-the-badge)](https://discord.gg/fjBugmvzZP)
2021-09-28 20:33:56 +10:00
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> •
2022-02-09 12:21:11 +11:00
<a href="https://discord.gg/fjBugmvzZP"><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 21:15:06 +10:00
[![License](https://img.shields.io/github/license/rowyio/rowy)](https://github.com/rowyio/rowy/blob/main/LICENSE)
[![Last commit](https://img.shields.io/github/last-commit/rowyio/rowy/rc)](https://github.com/rowyio/rowy/commits/rc)
[![GitHub stars](https://img.shields.io/github/stars/rowyio/rowy)](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-10-02 07:55:19 +10:00
## Live Demo
💥 Check out the [live demo](https://demo.rowy.io/) of Rowy 💥
## Quick Deploy
2021-08-05 03:05:52 +10:00
Set up Rowy on your Google Cloud Platform project with this one-click deploy
button.
2022-01-27 22:20:01 +11:00
[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://rowy.app/deploy)
2020-10-04 15:44:18 +11:00
2022-01-27 22:20:01 +11:00
https://rowy.app/deploy
2021-12-01 17:40:27 +05:30
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
2021-11-19 00:07:04 +11:00
### Automate with cloud functions and ready made extensions
2021-09-28 21:15:06 +10:00
- Effortlessly build cloud functions on field level triggers right in the browser
- Use any NPM modules or APIs
- Connect to your favourite tool with pre-built extensions or create your own
- SendGrid, Algolia, Twilio, Bigquery and more
2021-09-28 11:36:46 +10:00
### 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)
2021-09-28 21:15:06 +10:00
- 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)
- Data validation, default values, required fields
2021-09-28 11:36:46 +10:00
- Action field: Clickable trigger for any Cloud Function
- Aggregate field: Populate cell with value aggregated from the rows sub-table
2021-09-28 21:15:06 +10:00
- Connect Table: Get snapshot of data from another data table using Algolia
- Connect Service: Get data from any HTTP endpoint
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
2021-09-28 20:33:56 +10:00
## Install
2021-11-19 00:07:04 +11:00
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.
2021-09-28 20:33:56 +10:00
2022-01-27 22:20:01 +11:00
[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://rowy.app/deploy)
2021-09-28 20:33:56 +10:00
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-11-19 00:07:04 +11:00
## Roadmap
[View our roadmap](https://demo.rowy.io/table/roadmap) on Rowy - Upvote, downvote, share your thoughts!
If you'd like to propose a feature, submit an issue [here](https://github.com/rowyio/rowy/issues/new?assignees=&labels=&template=feature_request.md&title=).
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!
2022-02-09 12:21:11 +11:00
- [Discord](https://discord.gg/fjBugmvzZP)
2021-09-24 09:40:37 +10:00
- [Twitter](https://twitter.com/rowyio)
- [Email](mailto:rowy.io)