diff --git a/README.md b/README.md index 86c30e4d98..4296a4ebd1 100644 --- a/README.md +++ b/README.md @@ -1,172 +1,139 @@ -

- Appsmith.com logo -
- Build and self-host all your internal apps. -
-

+Appsmith - The Frontend Tool for Backend DevsAppsmith - The Frontend Tool for Backend Devs -

- Try Online Sandbox -

-

+

+ Start Building + β€’ + Features + β€’ Documentation - Β· - Discord - Β· - Office Hours

+ 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. +
+

+

---- +## Quick Start -
-Appsmith is a JavaScript-based visual development platform to build and launch internal tools quickly. Drag-and-drop pre-built widgets, and connect them using JavaScript to create interactive pages. Connect UI to your APIs and Databases to build complex workflows in minutes.

+The fastest way to start with Appsmith is the cloud-hosted version. When you're ready, you can also host it yourself. -**UI Components**: Table, Chart, Form, Map, Image, Video, and many more.
-**API Support**: REST APIs, OAuth 2.0, CURL
-**Database Support**: PostgreSQL, MongoDB, MySQL, Firestore, S3, Redshift, Elastic Search, DynamoDB, Redis, and MSFT SQL Server
-**Hosting**: Cloud-hosted & On-premise +- 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) -Already familiar with Appsmith? [Quickly start building on your own](#%EF%B8%8F-quickstart). +
Build an Internal Tool with Appsmith -
+### Demos - -

- - - +Check out some real applications that can be built with Appsmith: + +- πŸ‘©β€πŸ’» [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) +

+ +## Features + +

+ + +

-## 🏭 Features +#### ↗️ Drag & Drop UI -- **5-minute setup**: Deploy Appsmith on your server, or use our cloud version to start building in 5 minutes. [Quick Start](#%EF%B8%8F-quickstart) -- **Frontend as a service**: Drag-and-drop from pre-built UI widgets like table, form, and image, to build sophisticated **dashboards** and **workflows, without writing HTML/CSS**. Write JavaScript anywhere to transform data, and dynamically control widget-properties. -- **Database CRUD**: Query & update your database directly by connecting it to the UI. Connect to **PostgreSQL, MongoDB, MySQL & more!** -- **Trigger APIs**: Connect to REST APIs to build custom apps. -- **Security**: DB Credentials are AES 256 encrypted and no data is stored by appsmith. Deploy behind your private VPC for additional security! -- **One-click deployment**: Managed deployment of your apps with a click of a button. -- **Access-control**: Assign users different roles & control who can edit / view your applications. -- **Supports OAuth**: Allow users to authenticate via Google Auth or GitHub Auth. +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. -## πŸ“Ί Demo +> _Includes text, forms, inputs, buttons, tables, images, charts, checkboxes, switches, radio buttons, datepickers, dropdowns, filepickers, containers, maps, modals, rich text editors, tabs & video_ >
-Unsure if Appsmith is for you? [Watch it in action here!](http://bit.ly/appsmith-demo-github) +#### ⏱ Quick Integrations -But if you’d rather check out some real applications that can be built with Appsmith, check below: +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). -- [Customer Support Dashboard](https://bit.ly/cs-dashboard-appsmith) -- [Job Application Tracker](https://bit.ly/3hbYtTi) +> _Currently works with PostgreSQL, MongoDB, MySQL, Firestore, S3, Redshift, Elastic Search, DynamoDB, Redis, and MSFT SQL Server_ >
-## πŸƒβ€β™€οΈ Quickstart +#### πŸ€– Code Logic with JavaScript -The following steps introduce you to building a simple user-list dashboard on Appsmith. +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).

-1. [Sign up on Appsmith Cloud](https://app.appsmith.com/signup?utm_source=github&utm_medium=social&utm_content=website&utm_campaign=null&utm_term=website) or [Deploy Appsmith](https://docs.appsmith.com/setup). -2. Create a new app within the organization that has already been created for you. -3. Click on the `+` icon next to the `Queries` section to add a new query in the mock database - 1. Name the query `usersQuery`. - 2. Write the query `select * from users limit 5;`. - 3. Run the query. -4. Click on the `+` icon next to the `Widgets` section and drag a table onto the screen -5. Link the table data property to the `usersQuery` using JavaScript `{{usersQuery.data}}` -6. Hit the Deploy button and checkout the view mode of the app. +#### ☝️ One-click Deploy & Access Control -Congratulations πŸŽ‰ You just built your first app on Appsmith! -Connect your own data to build apps for your team. [Read more here.](https://docs.appsmith.com/core-concepts) +[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.

-## πŸ“š Tutorials +#### πŸ”‘ Solid 256-bit Encryption -1. [Building an Admin Panel on MongoDB using Appsmith](https://blog.appsmith.com/building-an-admin-panel-with-mongodb-using-appsmith) ([Video](https://www.youtube.com/watch?v=tisUaIgI86k)) -2. [Building a Customer Support Dashboard in Appsmith](https://www.youtube.com/watch?v=-O_6OLREEzo&t=272s) -3. [Building a Store Catalogue Management System using Appsmith and GraphQL](https://blog.appsmith.com/building-a-store-catalogue-management-system-using-appsmith-and-graphql) -4. [Running CI/CD Jobs Manually using Appsmith](https://blog.appsmith.com/how-to-run-manual-jobs-in-gitlab-cicd) ([Video](https://www.youtube.com/watch?v=CYdeJcD4I8A)) -5. [Building a Calendly Clone in Appsmith](https://blog.appsmith.com/how-to-build-a-calendly-clone-in-30-minutes) -6. [Building Internal Tools with Appsmith](https://youtu.be/eYYYfuW-kEE) `Community` -7. [Building an Issue Tracker with Appsmith](https://dev.to/pjmantoss/how-to-build-an-issue-tracker-with-appsmith-204e) `Community` +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).

-## πŸ“• Support & Troubleshooting +#### πŸŽ™ Transparent Support -If you encountered a bug or need help troubleshooting an issue, you can use one of the following channels: +Issues are inevitable. When you have one, our entire team is around to helpβ€” -- Self Help: [Documentation](https://docs.appsmith.com) -- Community Support: [Discord](https://discord.gg/rBTTVJp) -- Issue & bug tracking: [GitHub Issues](https://github.com/appsmithorg/appsmith/issues/new/choose) +- πŸ’¬ 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) +

-## πŸ§‘β€πŸ€β€πŸ§‘ Contributing +## Contribute -If you're interested in contributing to Appsmith: +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β€” -1. Start by reading our [Contribution Guide](https://github.com/appsmithorg/appsmith/blob/master/CONTRIBUTING.md). -2. Learn how to set up your local environment, in our [developer-guide](https://github.com/appsmithorg/appsmith/blob/master/contributions/CodeContributionsGuidelines.md#-setup-for-local-development). -3. Explore our list of [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22). +- πŸ“– 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) -We are committed to fostering an open and welcoming environment in the community. Please read our [Code of Conduct](CODE_OF_CONDUCT.md). - -NOTE: If you are focused towards the client side development, We recommend you to start from [Running client codebase](https://github.com/appsmithorg/appsmith/blob/master/contributions/ClientSetup.md). You can also use our release environment as you backend server, to avoid setting up a local backend server/database etc. [Learn more here](https://github.com/appsmithorg/appsmith/blob/master/contributions/ClientSetup.md#if-you-would-like-to-hit-a-different-appsmith-server) - -## πŸ“‘ License - -The Appsmith platform is available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) (Apache-2.0). - -## Contributors +#### Currently Contributing (36) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Arpit Mohan
πŸ’»
Nikhil Nandagopal
πŸ“– πŸ’» πŸ“†
areyabhishek
πŸ€” 🎨
Trisha Anand
πŸ’» πŸš‡ πŸ€”
Hetu Nandu
πŸ’» ⚠️ πŸ€”
Abhinav Jha
πŸ’»
satbir121
πŸ’» πŸ€”

Shrikant Sharat Kandula
πŸ’» πŸ”Œ
Aakash Shrivastava
🎨
Debsourabh Ghosh
🎨
NandanAnantharamu
⚠️
prapullac
πŸ› ⚠️
Saket Agrawal
πŸ› πŸ“–
Harish Kotra
πŸ›

Ajay Kumar
πŸ› πŸ“–
Anshul Bansal
πŸ› πŸ’»
Navia Garg
πŸ›
Xniveres
πŸ›
Daniel Shuy
πŸ’» πŸ“–
Prashant Chaubey
πŸ’»
Adam
πŸ’»

Sumanth Yedoti
πŸ’»
Nidhi
πŸ’»
Pawan Kumar
πŸ’»
Sumit Kumar
πŸ’»
Rishabh Saxena
πŸ’»
Piyush Mishra
πŸ’»
akash-codemonk
πŸ’»

vicky-primathon
πŸ’»
devrk96
πŸ’»
Tim Dillon
πŸ’»
Zeger Hoogeboom
πŸ’»
Young Yoo
πŸ’»
Dwayne Forde
πŸ’» ⚠️
Abhishek
πŸ’»

Navdeep Singh
πŸ’»
+Arpit Mohan +Nikhil Nandagopal +Abhishek Nayak +Trisha Anand +Hetu Nandu +Abhinav Jha +Satbir +Shrikant Sharat Kandula +Aakash Shrivastava +Debsourabh Ghosh +Nandan Anantharamu +Prapullac +Saket Agarwal +Harish Kotra +Ajay Kumar +Anshul Bansal +Navia Garg +Xniveres +Daniel Shuy +Prashant Chaubey +Adam +Sumanth Yedoti +Nidhi +Pawan Kumar +Sumit Kumar +Rishabh Saxena +Piyush Mishra +akash-codemonk +vicky-primathon +devrk96 +Tim Dillon +Zeger Hoogeboom +Young Yoo +wayne Forde +Abhishek + + +
+ +## License + +Appsmith is available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). Use it wisely. diff --git a/static/images/animations/drag-drop.gif b/static/images/animations/drag-drop.gif new file mode 100644 index 0000000000..3dd76ab95d Binary files /dev/null and b/static/images/animations/drag-drop.gif differ diff --git a/static/images/animations/move-around.gif b/static/images/animations/move-around.gif new file mode 100644 index 0000000000..33dbc90e27 Binary files /dev/null and b/static/images/animations/move-around.gif differ diff --git a/static/images/animations/selections.gif b/static/images/animations/selections.gif new file mode 100644 index 0000000000..e12eef1158 Binary files /dev/null and b/static/images/animations/selections.gif differ diff --git a/static/images/animations/video-preview.gif b/static/images/animations/video-preview.gif new file mode 100644 index 0000000000..4f99ce4a36 Binary files /dev/null and b/static/images/animations/video-preview.gif differ diff --git a/static/images/build-tool.png b/static/images/build-tool.png new file mode 100644 index 0000000000..45d19c17aa Binary files /dev/null and b/static/images/build-tool.png differ diff --git a/static/images/git-banner-left.png b/static/images/git-banner-left.png new file mode 100644 index 0000000000..7e78bb5115 Binary files /dev/null and b/static/images/git-banner-left.png differ diff --git a/static/images/git-banner-right.png b/static/images/git-banner-right.png new file mode 100644 index 0000000000..7c9e53c46b Binary files /dev/null and b/static/images/git-banner-right.png differ diff --git a/static/images/git-banner.jpg b/static/images/git-banner.jpg new file mode 100644 index 0000000000..9adddfcd14 Binary files /dev/null and b/static/images/git-banner.jpg differ diff --git a/static/images/integrations.png b/static/images/integrations.png new file mode 100644 index 0000000000..e66403cc8a Binary files /dev/null and b/static/images/integrations.png differ diff --git a/static/images/users.png b/static/images/users.png new file mode 100644 index 0000000000..de72bb351d Binary files /dev/null and b/static/images/users.png differ