OceanSlim/grain
1
0
Fork 0
mirror of https://github.com/0ceanSlim/grain.git synced 2024-11-21 16:17:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Go Relay Architecture for Implementing Nostr 🌾
74 Commits 2 Branches 6 Tags 584 KiB
Go 94%
HTML 4.8%
CSS 0.7%
JavaScript 0.5%
f291c07bfa
Go to file
0ceanSlim f291c07bfa readme change
2024-07-31 12:30:42 -04:00
config create config and metadata if none exists 2024-07-31 12:27:56 -04:00
relay create config and metadata if none exists 2024-07-31 12:27:56 -04:00
tests configuration refactor 2024-07-30 11:27:38 -04:00
web create config and metadata if none exists 2024-07-31 12:27:56 -04:00
.gitignore hotfix 2024-07-28 09:41:10 -04:00
go.mod added ws close on error 2024-07-30 09:31:26 -04:00
go.sum added ws close on error 2024-07-30 09:31:26 -04:00
license first commit 2024-07-19 18:07:04 -04:00
main.go create config and metadata if none exists 2024-07-31 12:27:56 -04:00
readme.md readme change 2024-07-31 12:30:42 -04:00

readme.md

GRAIN 🌾

Go Relay Archetecture for Implementing Nostr

GRAIN is an open-source Nostr relay implementation written in Go. This project aims to provide a robust and efficient Nostr relay that currently supports the NIP-01 of the nostr protocol.

Features

  • NIP-01 Protocol Support: GRAIN (nearly)fully supports NIP-01 for WebSocket communication.
  • Event Processing: Handles all events by category and kind.
  • MongoDB 🍃: Utilizes MongoDB to store and manage events efficiently.
  • Scalability: Built with Go, ensuring high performance and scalability.
  • Open Source: Licensed under the MIT License, making it free to use and modify.

Configuration

Grain will automatically create the configurations and relay metadata files necessary if they do not already exist when you first run the program.

They are created in the root directory of Grain. Feel free to change any coinfigurations you want in these files.

TODO

  • configurable event purging
    • by category
    • by kind
    • by time since latest
  • create whitelist/blacklist functionality for:
    • valid nip05 domain
    • pubkey
    • npub
    • kind int
    • kind 1 wordlist

Development

To contribute to GRAIN, follow these steps:

  1. Fork the repository.

  2. Make your changes.

  3. Commit your changes:

    git commit -m "Description of changes"

  4. Push to the repo:

    git push

  5. Create a Pull Request.

License

This project is Open Source and licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

Special thanks to the Nostr community for their continuous support and contributions.

Feel free to reach out with any questions or issues you encounter while using GRAIN. Happy coding!