Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 4.21 KB

README.md

File metadata and controls

112 lines (74 loc) · 4.21 KB
Raw

HashBot Logo

✨ Redefining your Hashnode experience with AI.

contributions welcome License: MIT

Live Demo 🚀

HashBot

📜 About

HashBot is your go-to application, designed to allow you perform action on your Hashnode account away from the "noise." Read up the article to know more about HashBot:

Article Preview

Link: https://omzi.hashnode.dev/redefining-your-hashnode-experience-with-hashbot

⚙️ Features

  • AI Chat (on temporary hiatus)
  • Seamless Post Import (DEV.to & Medium)
  • Infinite Posts & Drafts Viewing
  • Hashnode Token Sign-In
  • Sidebar with Post & Draft Count
  • Light/Dark Mode Switcher
  • Globally Accessible Command Modal (⌘ + K)

🛠 Tech Stack

🚩 Prerequisites

Ensure that your system meets the following requirements:

⚡ Installation

Before proceeding, make sure your system satisfies the prerequisites mentioned above.

Firstly, clone the HashBot repository into your desired folder and navigate into it:

$ git clone https://github.com/omzi/hashbot && cd hashbot

Install the project dependencies using npm (or yarn if you prefer):

npm i

⚙ Environment Variables

HashBot requires certain environment variables to be set to function properly. Create a .env file in the root of your project and add the following variables:

NODE_ENV = # Your current environment
NEXT_PUBLIC_HASHNODE_GQL_ENDPOINT = # Hashnode's GraphQL API endpoint
OPENAI_API_KEY = # Your OpenAI API key

Explanation of the environment variables:

  • NODE_ENV: Set it to development for local development.
  • NEXT_PUBLIC_HASHNODE_GQL_ENDPOINT: Hashnode's GraphQL API endpoint. Set the value to https://gql.hashnode.com. For external services:
  • OPENAI_API_KEY: Your OpenAI API key. If you don't have an API key, you'll have to create one.

Once the environment variables are set, you can run HashBot locally with:

npm run dev

Visit the URL http://localhost:3000/ in your browser to access the HashBot application.

👥 Contributors

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

❌ Disclaimer

HashBot is a work-in-progress. You may experience errors or bugs while testing out the application. Feel free to reach to me on Twitter (@0xOmzi) regarding any issue you might be facing.

Back To Top ↺

Made with ♥