Files
rowy/README.md

143 lines
5.4 KiB
Markdown
Raw Normal View History

2023-02-13 12:44:40 +11:00
<a href="https://www.rowy.io/" target="_blank">
<img width="100%" src="https://user-images.githubusercontent.com/307298/218350866-cfd7c011-2247-4074-8b1d-06c26a4d0b96.png" />
</a>
2021-09-24 23:22:52 +10:00
2022-12-31 00:05:39 +11:00
<h4 align="center">
2023-02-13 12:44:40 +11:00
✨ Airtable-like UI for managing database ✨ Build any automation, with or without code ✨
2022-12-31 00:05:39 +11:00
</h4>
<p align="center" >
2023-02-13 12:44:40 +11:00
Connect to your database and create Cloud Functions in low-code - without leaving your browser.<br/>
Focus on building your apps.
Low-code for Firebase and Google Cloud.
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
2023-04-09 11:18:33 +10:00
[![Rowy Discord](https://dcbadge.vercel.app/api/server/fjBugmvzZP)](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> •
2023-04-09 11:18:33 +10:00
<a href="https://discord.gg/fjBugmvzZP"><b>Chat with us</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
[![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
2023-04-09 11:18:33 +10:00
## Live Demo 🛝
2022-09-16 16:38:08 +02:00
2023-04-09 11:18:33 +10:00
💥 Explore Rowy on [live demo playground](https://demo.rowy.io/) 💥
2021-10-02 07:55:19 +10:00
2023-04-09 11:18:33 +10:00
## Features ✨
2021-09-26 15:12:30 +10:00
2023-02-13 12:44:40 +11:00
<!-- <table>
<tr>
<th>
<a href="#">Database</a>
</th>
<th>
2023-04-09 11:18:33 +10:00
<a href="#">Automation</a>
2023-02-13 12:44:40 +11:00
</th>
</tr>
<tr>
<td>
<a href="#">
<img src=""/>
</a>
</td>
<td>
<a href="#">
<img src=""/>
</a>
</td>
</tr>
</table> -->
2022-03-08 18:15:58 +11:00
https://user-images.githubusercontent.com/307298/157185793-f67511cd-7b7b-4229-9589-d7defbf7a63f.mp4
<!-- <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" />
-->
2022-09-16 16:38:08 +02:00
2021-09-28 11:36:46 +10:00
### Powerful spreadsheet interface for Firestore
2021-09-26 15:12:30 +10:00
2022-06-30 18:43:33 +10:00
- CMS for Firestore
2021-09-28 11:36:46 +10:00
- CRUD operations
2022-06-30 18:43:33 +10:00
- Bulk import or export data - csv, json, tsv
2021-09-28 11:36:46 +10:00
- Sort and filter by row values
- Lock, Freeze, Resize, Hide and Rename columns
- Multiple views for the same collection
2021-11-19 00:07:04 +11:00
### Automate with cloud functions and ready made extensions
2021-09-28 21:15:06 +10:00
2022-09-16 16:38:08 +02:00
- Build cloud functions workflows on field level data changes
- Use any NPM modules or APIs
2022-06-30 18:43:33 +10:00
- Connect to your favourite tool with pre-built code blocks or create your own
2022-09-16 16:38:08 +02:00
- SendGrid, Algolia, Twilio, Bigquery and more
2021-09-28 21:15:06 +10:00
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)
2022-09-16 16:38:08 +02: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), Markdown
2022-06-30 18:43:33 +10:00
- 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
2022-09-16 16:38:08 +02:00
- Connector field: Connect data from multiple table collections
2021-09-28 21:15:06 +10:00
- 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
2022-06-30 18:43:33 +10:00
with role based access controls
2021-09-28 11:36:46 +10:00
- Built in user management
- Customizable views for different user roles
2023-02-13 12:44:40 +11:00
## Quick guided install
2021-09-28 20:33:56 +10:00
2023-02-13 12:44:40 +11:00
Set up Rowy on your Google Cloud Platform project with this easy deploy button. Your
data and cloud functions stay on your own Firestore/GCP and is managed via a cloud run instance that operates exclusively on your GCP project. So we do do not access or store any of your data on Rowy.
2021-09-28 20:33:56 +10:00
2023-02-13 12:44:40 +11:00
[<img width="200" alt="Guided quick start button" src="https://user-images.githubusercontent.com/307298/185548050-e9208fb6-fe53-4c84-bbfa-53c08e03c15f.png">](https://rowy.app/)
https://rowy.app
2021-09-28 20:33:56 +10:00
2023-02-13 12:44:40 +11:00
## Documentation
You can find the full documentation with how-to guides and templates
[here](http://docs.rowy.io/).
2021-09-28 11:36:46 +10:00
2023-02-13 12:44:40 +11:00
## Manual Install
2021-09-26 15:12:30 +10:00
2023-02-13 12:44:40 +11:00
We recommend the [quick guided install](https://github.com/rowyio/rowy#quick-guided-install) option above. Manual install option is only recommended if you want to develop and contribute to the project. Follow this [guide](https://docs.rowy.io/setup/install#option-2-manual-install) for manual setup.
2021-09-26 15:12:30 +10:00
2021-11-19 00:07:04 +11:00
## Roadmap
2023-01-23 18:21:30 +11:00
[View our roadmap](https://roadmap.rowy.io/) on Rowy - Upvote,
2022-09-16 16:38:08 +02:00
downvote, share your thoughts!
2021-11-19 00:07:04 +11:00
2022-09-16 16:38:08 +02:00
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-11-19 00:07:04 +11:00
2022-03-08 18:15:58 +11:00
## Support the project
2022-09-16 16:38:08 +02:00
- Join a community of developers on [Discord](https://discord.gg/fjBugmvzZP) and
share your ideas/feedback 💬
- Follow us on [Twitter](https://twitter.com/rowyio) and help
[spread the word](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)
🙏
2022-03-08 18:15:58 +11:00
- Give us a star to this Github repo ⭐️
2022-09-16 16:38:08 +02:00
- Submit a PR. Take a look at our
[contribution guide](https://github.com/rowyio/rowy/blob/main/CONTRIBUTING.md)
and get started with
[good first issues](https://github.com/rowyio/rowy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
2022-03-08 18:15:58 +11:00
## Help
2023-01-23 18:21:30 +11:00
- Live chat support on [Discord](https://www.rowy.io/discord)
2022-03-08 18:15:58 +11:00
- [Email](mailto:hello@rowy.io)