Schiiit is a straightforward Electron-based application, serving as a cheat sheet container. Its conception stemmed from my journey in learning vim and developing new motor skills. To make the learning experience more interactive and useful, the navigation and other features of the app are designed to aid the learning process.
The project's foundation was laid using create-react-app. As it started to take shape, typescript and tailwindcss were integrated into the build. Finally, it was set up as an electronjs app to provide a desktop application experience.
Follow the steps below to get Schiiit up and running:
- Clone this repository to your local machine.
- Navigate into the project directory and run
yarn install. - Open two terminal windows:
a. Run the React app in the first terminal using
yarn start. b. Start the Electron app in the second terminal withyarn electron.
Voila! Enjoy your Schiiit experience.
To enhance the user experience, Schiiit supports a range of keyboard shortcuts:
o: Opens the sidebar menu.c: Closes the sidebar menu.d: Switches to dark mode theme.l: Switches to light mode theme.a: Navigates to the [buffer] Text theme.b: Navigates to the second page.