README.md

Built with ❤️ by ohmycheatsheet. Cheatsheets is a part of ohmycheatsheet project, a self-host cheatsheet management app! It sync your github issues to website with friendly UI~

features

• 🚀 Easy and Fast develop
• 🔍 Search cheasheet with algolia
• 🌥️ Cool Website
  • ✨ Support code-share with url or image
• 🤖 Useful Assistants Tools
  • 📩 Slack bot - Support send your recently/some-day-your-created cheatsheets with slack-bot

snapshots

▲ cheatsheets-homepage

usage

Deploy

vercel

1. Use this repo as template

2. New dataset from algolia

3. Set below github repo secrets

   • ALGOLIA_APPID=<ALGOLIA_APPID> - copy from algolia-api-keys
   • ALGOLIA_APP_KEY=<ALGOLIA_APP_KEY> - copy from algolia-api-keys
   • SLACK_WEBHOOK=<SLACK_WEBHOOK> - check actions-friday usage

4. Deploy to Vercel'now, in Vercel deployments settings, set below env variables as Production & Preview & Development Environment Variables

   

   • GITHUB_TOKEN
   • NEXT_PUBLIC_ALGOLIA_APPID - copy from algolia-api-keys
   • NEXT_PUBLIC_ALGOLIA_SEARCH_KEY - copy from algolia-api-keys
   • ALGOLIA_APP_KEY - copy from algolia-api-keys

5. new issue on github'issue

netlify

1. Use this repo as template

2. New dataset from algolia

3. Set below github repo secrets

   • ALGOLIA_APPID=<ALGOLIA_APPID> - copy from algolia-api-keys
   • ALGOLIA_APP_KEY=<ALGOLIA_APP_KEY> - copy from algolia-api-keys
   • SLACK_WEBHOOK=<SLACK_WEBHOOK> - check actions-friday usage

4. Deploy to Netlify'now, in Netlify deployments settings, set below env variables as Production & Preview & Development Environment Variables

   

   • GITHUB_TOKEN
   • NEXT_PUBLIC_ALGOLIA_APPID - copy from algolia-api-keys
   • NEXT_PUBLIC_ALGOLIA_SEARCH_KEY - copy from algolia-api-keys
   • ALGOLIA_APP_KEY - copy from algolia-api-keys

5. new issue on github'issue

Analytics

Collect page-view data, set env variable GA_MEASUREMENT_ID from https://analytics.google.com/