docs: add quick start guide using the slack cli and terminal #1317
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #1317 +/- ##
=======================================
Coverage 90.96% 90.96%
=======================================
Files 222 222
Lines 7501 7501
=======================================
Hits 6823 6823
Misses 678 678 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
@technically-tracy Wow! Thanks so much for putting this together so fast 🤖 ✨
I left a few comments on changes we'll need to make on the linked sample app and also some sample code we might want to include here!
These paths otherwise read well and some comments have thoughts on separating requirements more, but right now this makes most sense with the current capabilities released in the CLI ⚡
The comments on incoming CLI changes IMO don't have to block this from releasing either if we're alright with fast follows as well! 🚢 💨
There was a problem hiding this comment.
@technically-tracy The quickstart is quite fast for starting in both setups though perhaps I've created too many apps... 📚
I requested a few changes around commands when setting the app up and exact outputs that might help avoid confusions later.
I'm not sure that automatic virtual environments have landed for the CLI at this time and might need to be documented, but we should revisit this later once that's stable ⛰️ ✨
|
👀 I'm noticing tests are failing for some reason also, but perhaps unrelated! Going to investigate this soon 🫡 |
There was a problem hiding this comment.
✅ Amazing work @technically-tracy!
🧪 I've read through the entire Quickstart Guide and manually followed the Slack CLI and Terminal steps. Both paths work well.
👏🏻 I was hoping to give you some feedback, but I have nothing for you. Everything looks excellent from my side!
Summary
Docs: guide quick start app creation using the slack CLI following the Bolt for JS structure authored by @zimeg.
Testing
Category
slack_bolt.Appand/or its core componentsslack_bolt.async_app.AsyncAppand/or its core componentsslack_bolt.adapter/docsRequirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.