{"id":20430848,"url":"https://github.com/ulughann/essence","last_synced_at":"2026-03-17T21:04:27.830Z","repository":{"id":214850697,"uuid":"737511836","full_name":"ulughann/essence","owner":"ulughann","description":"Pure, Type-Safe and Minimal template for Discord.js v14 and Slash Commands","archived":false,"fork":false,"pushed_at":"2024-01-05T15:26:10.000Z","size":14,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T20:37:19.181Z","etag":null,"topics":["altyapi","altyapi-bot","discord","discord-bot","discord-js"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ulughann.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-31T10:23:37.000Z","updated_at":"2024-09-08T19:29:52.000Z","dependencies_parsed_at":"2024-01-05T16:34:28.899Z","dependency_job_id":null,"html_url":"https://github.com/ulughann/essence","commit_stats":null,"previous_names":["onrirr/essence","ulughann/essence"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ulughann/essence","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ulughann%2Fessence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ulughann%2Fessence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ulughann%2Fessence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ulughann%2Fessence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ulughann","download_url":"https://codeload.github.com/ulughann/essence/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ulughann%2Fessence/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30631432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T17:32:55.572Z","status":"ssl_error","status_checked_at":"2026-03-17T17:32:38.732Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["altyapi","altyapi-bot","discord","discord-bot","discord-js"],"created_at":"2024-11-15T08:09:16.433Z","updated_at":"2026-03-17T21:04:27.806Z","avatar_url":"https://github.com/ulughann.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/onrirr/onrirr/main/small.png\" alt=\"Essence logo\"\u003e\n\n\u003ch1 style=\"font-size: 36px\"\u003eEssence\u003c/h1\u003e\n\nPure, Type-Safe and Minimal template for Discord Bots using [Discord.js v14](https://discord.js.org/)\n\n\u003ch1 style=\"display: flex; align-items: center; font-size: 24px;\"\u003eGet Started\u003c/h1\u003e\n\nAfter cloning the repository with `git clone`, add your bot token to the `config` file\n\nconfig:\n```\ntoken = XXXXXXXXXXXXXX_XXXXXXX_XXXXXXXXXXXXX\n```\n\nThen, install the dependencies and run the bot with `npm run dev`\n\n```bash\nnpm install\nnpm run dev\n```\n\n\u003ch1 style=\"display: flex; align-items: center; font-size: 24px;\"\u003eProject Structure\u003c/h1\u003e\n  \n```\nEssence\n├── src\n│   ├── commands\n│   │   ├── command.ts\n│   │   └── subdirectory/\n│   │       └── command.ts\n│   ├── events\n│   │   ├── event.ts\n|   |\n│   └── utils\n│   |   ├── ...\n│   |\n│   └── index.ts\n│\n├── config\n├── logs.yml\n├── .gitignore\n├── package.json\n├── tsconfig.json\n└── nodemon.json\n```\n\n## Commands\nCommands are positioned in the `commands/` directory (of course subdirectories to `commands/` are allowed, eg. `commands/moderation/ban.ts`), and are loaded automatically by the bot. Commands are structured as follows:\n\n```ts\nimport { SlashCommandBuilder } from \"@discordjs/builders\";\n\nexport default {\n  data: new SlashCommandBuilder()\n  .setName(\"ping\")             // check out the command builder docs for more info\n  .setDescription(\"Pong!\"),    \n  run: async (client, interaction) =\u003e {\n    // comamnd body\n  }\n};\n```\n\n## Events\nEvents are positioned in the `events/` directory, and are loaded automatically by the bot. Events are structured as follows:\n\n```ts\nimport { Client } from \"discord.js\";\n\nexport default {\n\tname: 'ready',\n\tonce: true, // true if event should only be executed once\n\texecute(client: Client) {\n\t\t// event body\n\t},\n};\n```\n\n## Utils\nUtils are positioned in the `utils/` directory, and are extra code that helps you with your bot. Utils have no structure, and can be anything you want them to be. By default there is a `console.ts` util for structured logging, `log.ts` util for logging to a file and the `configParser.js` to read the [NOML](https://github.com/onrirr/noml) config file.\n\n### Structured Logging\nThe `console.ts` util is used for structured logging. It is used as follows:\n\n```ts\nimport { Print, Warn, Inform, Error } from \"./utils/console\";\n\nPrint(\"Hello World!\");\nWarn(\"Hello World!\");\nInform(\"Hello World!\");\nError(\"Hello World!\");\n```\n\n### Logging to a file\nThe `log.ts` util is used for logging to a file. It is used as follows:\n\nExample;\n\n```ts\nimport { Error } from \"./utils/console\";\nimport { $l } from \"./utils/log\";\n\ncatch (error) {\n  Error(\"Hello World!\", $l(error));\n}\n```\n\n(this adds the error to the log file in `logs.yml`, and logs it to the console)\n\n## Utils/intents.ts\nThis file is used to define the intents, shards and partials for your bot. By default, the intents are set to `GUILDS` and `GUILD_MESSAGES`. You can read more about intents [here](https://discordjs.guide/popular-topics/intents.html).\n\n\n\u003ch1 style=\"display: flex; align-items: center; font-size: 24px;\"\u003eRequirements\u003c/h1\u003e\n\n- [Node.js](https://nodejs.org/en/) v16 or higher\n\n  ![Stats](https://repobeats.axiom.co/api/embed/d86852e3898713e1283f4916a29d73a701c9266c.svg \"Repobeats analytics image\")\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulughann%2Fessence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fulughann%2Fessence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulughann%2Fessence/lists"}