The Discord Journal Bot is a chatbot designed to help users keep a journal directly within a Discord server. It provides a convenient way for users to write their daily journal entries, with the option to perform grammar checks using the TextGears API. Each user's entries are stored privately in separate JSON files.
- Journal Entry: Users can enter their daily journal entry by using the
!journalcommand. - Grammar Check: The bot offers the ability to perform grammar checks on the journal entry using the TextGears API.
- Private Storage: Each user's journal entries are stored privately in separate JSON files.
- Delete Entry: Users can delete their last journal entry using the
!deletecommand. - Modular and Extensible: The code is organized into separate modules for easy maintainability and extensibility.
This project is built with the following technologies:
- Node.js: A JavaScript runtime environment for server-side development.
- Discord.js: A powerful library for interacting with the Discord API.
- TextGears API: An API for grammar and style checking of textual content.
- JSON file storage: Simple file-based storage using JSON format.
To get started with the Discord Journal Bot, follow these steps:
- Clone the repository.
- Install dependencies. Run
npm install discord.js@14.11.0 dotenv@16.3.1 node-fetch@2.6.5to install the required dependencies. - Configure environment variables. Create a
.envfile in the root directory and provide the necessary environment variables (e.g., Discord bot token, TextGears API key and bot prefix). - Customize the bot. Modify the bot's behavior and commands as per your requirements.
- Run the bot. Launch the bot using
node bot.js. - Invite the bot. Invite the bot to your Discord server using the OAuth2 URL provided by Discord.
- Start journaling. Begin journaling by using the
-journalcommand.
Feel free to explore the code and make any modifications or improvements as needed. Happy journaling!
This project is licensed under the MIT License.