PromucFlow_constructor/README.md

140 lines
10 KiB
Markdown
Raw Normal View History

2021-05-24 19:16:51 +00:00
<img src="static/images/git-banner-left.png" width="410px" alt="Appsmith - The Frontend Tool for Backend Devs"><img src="static/images/git-banner-right.png" width="410px" alt="Appsmith - The Frontend Tool for Backend Devs">
2020-11-26 03:32:35 +00:00
2021-05-24 19:16:51 +00:00
<p>
<b><a href="https://app.appsmith.com/signup">Start Building</a></b>
<a href="https://www.appsmith.com/">Features</a>
Fix/readme v2 (#1262) * Readme overhaul * Removed emoji * Fixed PR comments * Fixed bullet list * Readme v2 images (#1338) * Add files via upload * Delete API.png * Delete Query.png * Add files via upload * Update README.md * Delete API.png * Delete Query.png * Add files via upload * Delete API.png * Delete Query.png * Delete Share.png * Add files via upload * Delete Share.png * Add files via upload * Delete API.png * Add files via upload * Delete API.png * Add files via upload * Delete API.png * Delete Query.png * Add files via upload * Delete Query.png * Add files via upload * Delete Query.png * Add files via upload * Add files via upload * Update README.md * Delete Query.png * Update README.md * Update README.md * Update README.md * Delete API.png * Delete Query1.png * Delete Share.png * Add files via upload * Add files via upload * Update README.md * Add files via upload * Update README.md * Add files via upload * Update README.md * Update README.md * Delete API.png * Delete Query1.png * Delete Share.png * Delete Share2.png * Delete Share3.png * Add files via upload * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Delete Share4.png * Update README.md * Update README.md * Update README.md * Review changes * Review changes * Review changes * Update README.md * Update README.md * Update README.md (#1402) * Update README.md * Update README.md * Update README.md * Add files via upload * Update README.md * Review changes Intro & Description * Fixed a sentence * Review changes * typo * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Nikhil Nandagopal <nikhil.nandagopal@gmail.com>
2020-11-02 10:55:05 +00:00
<a href="https://docs.appsmith.com/">Documentation</a>
<br>
<br>
2021-05-24 19:16:51 +00:00
Turn any datasource into an internal app in minutes. Appsmith lets you drag-and-drop components to build dashboards, write logic with JavaScript objects and connect to any API, database or GraphQL source.
<br>
<br><p><img src="static/images/integrations.png" width="320px"></p>
<br>
</p>
2021-05-24 19:16:51 +00:00
## Quick Start
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
The fastest way to start with Appsmith is the cloud-hosted version. When you're ready, you can also host it yourself.
Fix/readme v2 (#1262) * Readme overhaul * Removed emoji * Fixed PR comments * Fixed bullet list * Readme v2 images (#1338) * Add files via upload * Delete API.png * Delete Query.png * Add files via upload * Update README.md * Delete API.png * Delete Query.png * Add files via upload * Delete API.png * Delete Query.png * Delete Share.png * Add files via upload * Delete Share.png * Add files via upload * Delete API.png * Add files via upload * Delete API.png * Add files via upload * Delete API.png * Delete Query.png * Add files via upload * Delete Query.png * Add files via upload * Delete Query.png * Add files via upload * Add files via upload * Update README.md * Delete Query.png * Update README.md * Update README.md * Update README.md * Delete API.png * Delete Query1.png * Delete Share.png * Add files via upload * Add files via upload * Update README.md * Add files via upload * Update README.md * Add files via upload * Update README.md * Update README.md * Delete API.png * Delete Query1.png * Delete Share.png * Delete Share2.png * Delete Share3.png * Add files via upload * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Delete Share4.png * Update README.md * Update README.md * Update README.md * Review changes * Review changes * Review changes * Update README.md * Update README.md * Update README.md (#1402) * Update README.md * Update README.md * Update README.md * Add files via upload * Update README.md * Review changes Intro & Description * Fixed a sentence * Review changes * typo * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Nikhil Nandagopal <nikhil.nandagopal@gmail.com>
2020-11-02 10:55:05 +00:00
2021-05-24 19:16:51 +00:00
- Start building apps _2 minutes_ with [Appsmith Cloud](https://bit.ly/appsmith-signup-github)
- Install locally or on a private instance with [Docker](https://docs.appsmith.com/setup/docker) _(Recommended)_
- Deploy on a [Kubernetes](https://docs.appsmith.com/setup/kubernetes) cluster
- Deploy to [AWS with an AMI](https://docs.appsmith.com/setup/aws-ami) on the marketplace
- One-click deploy to [Heroku](https://docs.appsmith.com/setup/heroku)
2021-05-24 19:16:51 +00:00
<br><a href="http://bit.ly/appsmith-demo-github" target="_blank"><img src="static/images/build-tool.png" alt="Build an Internal Tool with Appsmith" width="410px" /></a>
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
### Demos
2021-05-24 19:16:51 +00:00
Check out some real applications that can be built with Appsmith:
2021-05-24 19:16:51 +00:00
- 👩‍💻 [Customer Support Dashboard](https://bit.ly/cs-dashboard-appsmith)
- 💼 [Job Application Tracker](https://bit.ly/3hbYtTi)
- 🌟 Made something cool? [Share it with the community](https://discord.gg/Tx395War)
<br><br>
2020-08-20 10:34:47 +00:00
2021-05-24 19:16:51 +00:00
## Features
2020-08-20 10:34:47 +00:00
2021-05-24 19:16:51 +00:00
<p>
<img src="static/images/animations/drag-drop.gif" width="32%">
<img src="static/images/animations/selections.gif" width="32%">
<img src="static/images/animations/move-around.gif" width="32%">
</p>
2020-08-05 12:42:09 +00:00
2021-05-24 19:16:51 +00:00
#### ↗️ Drag & Drop UI
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
Use [ready components](https://docs.appsmith.com/widget-reference/button) to build workflows in record time. Drag common elements like tables, charts, forms and more right into your app.
2020-08-05 12:42:09 +00:00
2021-05-24 19:16:51 +00:00
> _Includes text, forms, inputs, buttons, tables, images, charts, checkboxes, switches, radio buttons, datepickers, dropdowns, filepickers, containers, maps, modals, rich text editors, tabs & video_ > <br>
2020-08-05 12:42:09 +00:00
2021-05-24 19:16:51 +00:00
#### ⏱ Quick Integrations
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
Appsmith automagically works using any DB, Rest API or GraphQL as a datasource, with support for OAuth 2.0 and CURL. Here's a list of all our [pre-built integrations](https://docs.appsmith.com/core-concepts/connecting-to-data-sources/connecting-to-databases).
2021-05-24 19:16:51 +00:00
> _Currently works with PostgreSQL, MongoDB, MySQL, Firestore, S3, Redshift, Elastic Search, DynamoDB, Redis, and MSFT SQL Server_ > <br>
2021-05-24 19:16:51 +00:00
#### 🤖 Code Logic with JavaScript
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
All parts of your app can be referenced as JavaScript objects. Code interactions between elements, update datasources or manipulate SQL queries—[we'll parse JS anywhere](https://docs.appsmith.com/core-concepts/writing-code).<br><br>
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
#### ☝️ One-click Deploy & Access Control
2021-05-24 19:16:51 +00:00
[Push a button](https://docs.appsmith.com/core-concepts/access-control) to make your app public and get a shareable link, or privately invite your team using OAuth 2.0. Each member can be assigned a role with access to certain parts of the app.<br><br>
2021-05-24 19:16:51 +00:00
#### 🔑 Solid 256-bit Encryption
2021-05-24 19:16:51 +00:00
Appsmith apps are [secure by default](https://docs.appsmith.com/security). All connections are TLS-encrypted, and credentials are encrypted with AES-256—so we can't see any of your data. For added security, try our [self-hosted options](https://docs.appsmith.com/setup).<br><br>
2021-05-24 19:16:51 +00:00
#### 🎙 Transparent Support
2021-04-06 16:01:17 +00:00
2021-05-24 19:16:51 +00:00
Issues are inevitable. When you have one, our entire team is around to help—
2021-05-24 19:16:51 +00:00
- 💬 Talk to us on [Discord](https://discord.gg/rBTTVJp)
- 📄 Find a solution in our [Documentation](https://docs.appsmith.com)
- ⚠️ Open an issue right here on [GitHub](https://github.com/appsmithorg/appsmith/issues/new/choose)
<br><br>
2021-05-24 19:16:51 +00:00
## Contribute
2021-05-24 19:16:51 +00:00
We love our contributors! We're committed to fostering an open and welcoming environment in the community. If you'd like to contribute anything from a bug-fix to a feature update, start here—
2021-05-24 19:16:51 +00:00
- 📖 Read our [Contribution Guide](https://github.com/appsmithorg/appsmith/blob/master/CONTRIBUTING.md)
- 🧩 [Set up your local environment](https://github.com/appsmithorg/appsmith/blob/master/contributions/CodeContributionsGuidelines.md#-setup-for-local-development)
- 👾 Explore some [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22)
- 📕 Read our [Code of Conduct](CODE_OF_CONDUCT.md)
2021-05-24 19:16:51 +00:00
#### Currently Contributing (36)
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove / modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
2021-05-24 19:16:51 +00:00
<a href="http://arpitmohan.com"><img src="https://avatars2.githubusercontent.com/u/458946?v=4?s=100" width="60px;" alt="Arpit Mohan"/></a>
<a href="https://github.com/Nikhil-Nandagopal"><img src="https://avatars2.githubusercontent.com/u/3897254?v=4?s=100" width="60px;" alt="Nikhil Nandagopal"/></a>
<a href="https://github.com/areyabhishek"><img src="https://avatars1.githubusercontent.com/u/30255708?v=4?s=100" width="60px;" alt="Abhishek Nayak"/></a>
<a href="https://github.com/trishaanand"><img src="https://avatars2.githubusercontent.com/u/8403079?v=4?s=100" width="60px;" alt="Trisha Anand"/></a>
<a href="https://github.com/hetunandu"><img src="https://avatars2.githubusercontent.com/u/12022471?v=4?s=100" width="60px;" alt="Hetu Nandu"/></a>
<a href="https://github.com/riodeuno"><img src="https://avatars1.githubusercontent.com/u/103687?v=4?s=100" width="60px;" alt="Abhinav Jha"/></a>
<a href="https://github.com/satbir121"><img src="https://avatars3.githubusercontent.com/u/39981226?v=4?s=100" width="60px;" alt="Satbir"/></a>
<a href="https://sharats.me"><img src="https://avatars3.githubusercontent.com/u/120119?v=4?s=100" width="60px;" alt="Shrikant Sharat Kandula"/></a>
<a href="https://github.com/aakashDesign"><img src="https://avatars2.githubusercontent.com/u/65771350?v=4?s=100" width="60px;" alt="Aakash Shrivastava"/></a>
<a href="https://github.com/Debsourabh"><img src="https://avatars2.githubusercontent.com/u/34486435?v=4?s=100" width="60px;" alt="Debsourabh Ghosh"/></a>
<a href="https://github.com/NandanAnantharamu"><img src="https://avatars1.githubusercontent.com/u/67676905?v=4?s=100" width="60px;" alt="Nandan Anantharamu"/></a>
<a href="https://github.com/prapullac"><img src="https://avatars3.githubusercontent.com/u/71753653?v=4?s=100" width="60px;" alt="Prapullac"/></a>
<a href="https://github.com/Saket2"><img src="https://avatars0.githubusercontent.com/u/49346036?v=4?s=100" width="60px;" alt="Saket Agarwal"/></a>
<a href="https://harishkotra.me"><img src="https://avatars1.githubusercontent.com/u/4999463?v=4?s=100" width="60px;" alt="Harish Kotra"/></a>
<a href="https://github.com/visibleajay"><img src="https://avatars0.githubusercontent.com/u/13945951?v=4?s=100" width="60px;" alt="Ajay Kumar"/></a>
<a href="https://github.com/akbansa"><img src="https://avatars0.githubusercontent.com/u/13042781?v=4?s=100" width="60px;" alt="Anshul Bansal"/></a>
<a href="https://github.com/gogetter22"><img src="https://avatars3.githubusercontent.com/u/71608910?v=4?s=100" width="60px;" alt="Navia Garg"/></a>
<a href="https://github.com/Xniveres"><img src="https://avatars0.githubusercontent.com/u/56609232?v=4?s=100" width="60px;" alt="Xniveres"/></a>
<a href="https://github.com/daniel-shuy"><img src="https://avatars1.githubusercontent.com/u/17351764?v=4?s=100" width="60px;" alt="Daniel Shuy"/></a>
<a href="http://prashantchaubey.com"><img src="https://avatars3.githubusercontent.com/u/14848874?v=4?s=100" width="60px;" alt="Prashant Chaubey"/></a>
<a href="https://github.com/A-Scratchy"><img src="https://avatars0.githubusercontent.com/u/25309929?v=4?s=100" width="60px;" alt="Adam"/></a>
<a href="https://github.com/sumanthyedoti"><img src="https://avatars3.githubusercontent.com/u/30371888?v=4?s=100" width="60px;" alt="Sumanth Yedoti"/></a>
<a href="https://github.com/nidhi-nair"><img src="https://avatars2.githubusercontent.com/u/5298848?v=4?s=100" width="60px;" alt="Nidhi"/></a>
<a href="https://github.com/jsartisan"><img src="https://avatars1.githubusercontent.com/u/6636360?v=4?s=100" width="60px;" alt="Pawan Kumar"/></a>
<a href="https://github.com/sumitsum"><img src="https://avatars0.githubusercontent.com/u/1757421?v=4?s=100" width="60px;" alt="Sumit Kumar"/></a>
<a href="https://github.com/rishabhsaxena"><img src="https://avatars0.githubusercontent.com/u/1944800?v=4?s=100" width="60px;" alt="Rishabh Saxena"/></a>
<a href="https://github.com/ofpiyush"><img src="https://avatars0.githubusercontent.com/u/292174?v=4?s=100" width="60px;" alt="Piyush Mishra"/></a>
<a href="https://github.com/akash-codemonk"><img src="https://avatars2.githubusercontent.com/u/67054171?v=4?s=100" width="60px;" alt="akash-codemonk"/></a>
<a href="https://github.com/vicky-primathon"><img src="https://avatars2.githubusercontent.com/u/67091118?v=4?s=100" width="60px;" alt="vicky-primathon"/></a>
<a href="https://github.com/devrk96"><img src="https://avatars0.githubusercontent.com/u/68607686?v=4?s=100" width="60px;" alt="devrk96"/></a>
<a href="https://github.com/trdillon"><img src="https://avatars.githubusercontent.com/u/26350151?v=4?s=100" width="60px;" alt="Tim Dillon"/></a>
<a href="https://github.com/zegerhoogeboom"><img src="https://avatars.githubusercontent.com/u/5371096?v=4?s=100" width="60px;" alt="Zeger Hoogeboom"/></a>
<a href="https://github.com/Devedunkey"><img src="https://avatars.githubusercontent.com/u/29448764?v=4?s=100" width="60px;" alt="Young Yoo"/></a>
<a href="http://dwayne.io"><img src="https://avatars.githubusercontent.com/u/347097?v=4?s=100" width="60px;" alt="wayne Forde"/></a>
<a href="https://github.com/monarch0111"><img src="https://avatars.githubusercontent.com/u/2965013?v=4?s=100" width="60px;" alt="Abhishek"/></a>
<a href="http://www.navdeepsingh.in/"><img src="https://avatars.githubusercontent.com/u/2968787?v=4?s=100" width="60px;" alt=""/></a>
<br>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2021-05-24 19:16:51 +00:00
## License
Appsmith is available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). Use it wisely.