Documentation
ยท
@@ -19,7 +18,8 @@
@@ -40,50 +41,60 @@ Already familiar with Appsmith? [Quickly start building on your own](#%EF%B8%8F-
## ๐ญ Features
-* **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.
+- **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.
## ๐บ Demo
-Unsure if Appsmith is for you? [Watch it in action here](http://bit.ly/appsmith-demo-github)
+Unsure if Appsmith is for you? [Watch it in action here!](http://bit.ly/appsmith-demo-github)
But if youโd rather check out some real applications that can be built with Appsmith, check below:
-* [Customer Support Dashboard](https://bit.ly/cs-dashboard-appsmith)
-* [Job Application Tracker](https://bit.ly/3hbYtTi)
+
+- [Customer Support Dashboard](https://bit.ly/cs-dashboard-appsmith)
+- [Job Application Tracker](https://bit.ly/3hbYtTi)
## ๐โโ๏ธ Quickstart
The following steps introduce you to building a simple user-list dashboard on Appsmith.
+
1. [Sign up on Appsmith Cloud](https://bit.ly/appsmith-signup-github) 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.
+ 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.
-Congratulations ๐ You just built your first app on Appsmith!
+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)
+## ๐ Tutorials
+
+1. [How to run manual jobs in Gitlab CI/CD](https://blog.appsmith.com/how-to-run-manual-jobs-in-gitlab-cicd)
+2. [Build Your Admin Panel Without CSS or HTML](https://blog.appsmith.com/build-your-admin-panel-without-css-or-html)
+3. [Building an Admin Panel with MongoDB using Appsmith](https://blog.appsmith.com/building-an-admin-panel-with-mongodb-using-appsmith)
+4. [How to build a Calendly clone in 30 minutes](https://blog.appsmith.com/how-to-build-a-calendly-clone-in-30-minutes)
+
## ๐ Support & Troubleshooting
If you encountered a bug or need help troubleshooting an issue, you can use one of the following channels:
-* 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)
+- 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)
## ๐งโ๐คโ๐ง Contributing
If you're interested in contributing to Appsmith:
+
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).
@@ -96,7 +107,6 @@ The Appsmith platform is available under the [Apache License 2.0](https://www.ap
## Contributors
-