Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thehammerhq/hammer

🔨 Hammer Framework monorepo
https://github.com/thehammerhq/hammer

bot discord discord-bot discord-js discordjs djs easy framework hammer modular plugin ts typescript

Last synced: about 1 month ago
JSON representation

🔨 Hammer Framework monorepo

Host: GitHub
URL: https://github.com/thehammerhq/hammer
Owner: TheHammerHQ
License: gpl-3.0
Created: 2022-10-11T17:59:48.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-11-27T10:05:11.000Z (12 months ago)
Last Synced: 2024-10-10T15:32:40.970Z (about 1 month ago)
Topics: bot, discord, discord-bot, discord-js, discordjs, djs, easy, framework, hammer, modular, plugin, ts, typescript
Language: TypeScript
Homepage: https://hammer.338.rocks
Size: 853 KB
Stars: 3
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

TODO: check build steps for http plugin

Logo

Hammer Framework

Easiest way to make Discord bots with 3rd part plugins and CLI tool! No need for super complex coding knowledge!

Get support »

Report Bug
·
Documentation

# 🎈 Easy to Use

- If you don't know how to make a Discord bot then you can start with just a simple command as `npx create-hammer `!
- Everything is built on `discord.js`, which means if you already worked with it you are ready to step up further!
- If you have absolutely 0 idea how to code a bot or even don't know coding, you can easily install 3rd party plugins and add it to your codebase, no coding skills required!
- (WIP) If you don't want to mess with coding in any way, you can also use HammerGUI to create bots and add plugins to it!
- If you already know some things about coding, then you can start to produce your own plugins in order others to use it with Hammer's simple plugin development API!

# 🏃 Quick Start

- Create your bot without installing anything, with just one command:
```bash
$ npx create-hammer
```
- If you wan't to go further and start to develop your own plugins, everythins is same! Just run the same command:
```bash
$ npx create-hammer
```
- After running this command, Hammer CLI tool will ask you some questions about your project. You should select the template according to your project.
- For more information, please go to https://hammer.338.rocks

# 📦 Modular

- Everything is modular, you can easily contribute or even create your own plugins!
- You can add things from Hammer to your own project easily with [`@hammerhq/core`](https://npmjs.com/@hammerhq/core) package!

# 🛠️ Currently In Beta Phase

Hammer is still in development, you can contribute to Hammer and make it better with us!

# 🧦 Looking For Contributors

We are looking for contributors to actively work on Hammer and to contribute to the repos. There is still lots of work to do. If you are interested in contributing, please join our [Discord server](https://338.rocks/discord). (There will be a surprise for early contributors!)

# 📜 TODO

- [ ] see whats wrong with sequelize package, it doesnt see downloaded drivers.
- [ ] Increase the stability of the core package
- [ ] Add more documentation
- [✅] Convert this repo from a public bot to a framework!
- [ ] Create documentation website
- [✅] Edit README files

# 🔑 License

Distributed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html) License. See `LICENSE` for more information.

# 🧦 Contributing

This repo is open for #hacktoberfest. Feel free to use GitHub's features.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/my-feature`)
3. Run prettier (`npm run format`)
4. Commit your Changes (`git commit -m 'my awesome feature my-feature'`)
5. Push to the Branch (`git push origin feature/my-feature`)
6. Open a Pull Request

# ⭐️ Show your support

Give a ⭐️ if this project helped you!

# ☎️ Contact

- Mail: [email protected]
- Discord: https://338.rocks/discord
- Website: https://hammer.338.rocks