-
Notifications
You must be signed in to change notification settings - Fork 15
Home
Welcome to the wiki for Shortcut!
If you're reading this it's because you were invited to check out Shortcut in its pre-release phases. Shortcut is currently in Alpha and is not-quite-ready for prime time but we'd absolutely appreciate developer feedback and we wanted to give you a preview of how it all works under the hood.
Right now, this pre-release is for curious developers. If you have podcast audio you want to test with, and you have a written transcript or are willing to create one, then you'll be able to get Shortcut running in a local dev environment with your own podcast audio.
As of right now, you should be able to:
- Install Shortcut a local development machine (OSX is officially supported in the docs; Linux documentation will come soon; we're looking for brave Windows devs who want to contribute as well)
- Get our sample episode up and running
- Customize Shortcut's colors and logo
- Import at least one episode of your own podcast (as long as you have a transcript, which we provide instructions for)
- Submit bug reports and pull requests on Github
What you can't do right now:
- Bulk import a whole bunch of episodes (scripts for this coming soon)
- Import episodes that don't have transcripts (we'll support this eventually but not immediately)
- Deploy to a production server (in theory this is possible, we just don't have docs for it and haven't tested it)
To keep track of Shortcut and what's on the docket, check out our Milestones page. To ask for support, check out our Gitter chat.
By participating in our community you agree to abide by the Shortcut Code of Conduct.
Customization
Contributor Guidelines
Nitty-Gritty