https://github.com/Nostrology/astro

An Elixir based Nostr relay.
https://github.com/Nostrology/astro

Last synced: 24 days ago
JSON representation

An Elixir based Nostr relay.

• Host: GitHub
• URL: https://github.com/Nostrology/astro
• Owner: Nostrology
• License: mit
• Created: 2023-02-05T01:45:24.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T11:37:01.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T11:01:14.759Z (4 months ago)
• Language: Elixir
• Size: 60.5 KB
• Stars: 24
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-nostr - Astro - Elixir based implementation built to be performant and highly distributed. (Relays / Implementations)

README

        
# Astro

An [Nostr](https://github.com/nostr-protocol/nostr) relay, built using Elixir.

### Implementation

- [x] NIP-01: Basic protocol flow description

- [ ] NIP-02: Contact List and Petnames

- [ ] NIP-03: OpenTimestamps Attestations for Events

- [ ] NIP-05: Mapping Nostr keys to DNS-based internet identifiers

- [ ] NIP-09: Event Deletion

- [x] NIP-11: Relay Information Document

- [ ] NIP-12: Generic Tag Queries

- [x] NIP-15: End of Stored Events Notice

- [x] NIP-16: Event Treatment

- [x] NIP-20: Command Results

- [ ] NIP-22: Event created_at limits (future-dated events only)

- [ ] NIP-26: Event Delegation (implemented, but currently disabled)

- [ ] NIP-28: Public Chat

- [ ] NIP-33: Parameterized Replaceable Events

## Development

You can setup your own development / production environment of Astro easily by grabbing your dependencies, creating your database, and running the server.

  * Install dependencies with `mix deps.get`

  * Create and migrate your database with `mix ecto.setup`

  * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

Ready to run in production? Please [check out the deployment guides](https://hexdocs.pm/phoenix/deployment.html).

### Contributing

1. [Fork it!](http://github.com/Nostrology/astro/fork)

2. Create your feature branch (`git checkout -b feature/my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin feature/my-new-feature`)

5. Create new Pull Request

## Testing

Astro includes a comprehensive and very fast test suite, so you should be encouraged to run tests as frequently as possible.

```sh

mix test

```

## Help

If you need help with anything, please feel free to open [a GitHub Issue](https://github.com/Nostrology/astro/issues/new).

## License

WebSubHub is licensed under the [MIT License](LICENSE.md).