https://github.com/sgiath/spaceboy

Elixir framework for Gemini
https://github.com/sgiath/spaceboy

elixir gemini-protocol

Last synced: 2 months ago
JSON representation

Elixir framework for Gemini

• Host: GitHub
• URL: https://github.com/sgiath/spaceboy
• Owner: Sgiath
• License: other
• Created: 2025-01-21T20:22:58.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2025-01-21T20:40:09.000Z (4 months ago)
• Last Synced: 2025-03-17T05:45:32.610Z (2 months ago)
• Topics: elixir, gemini-protocol
• Language: Elixir
• Homepage:
• Size: 117 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spaceboy

The [Phoenix framework](https://www.phoenixframework.org/) for

[Gemini protocol](https://gemini.circumlunar.space/). Heavily simplified.

## Usage

I recommend you to look at `example/` folder which contains simple application

you can use as starting point.

## Features

- [x] TLS communication

- [x] routing

- [x] custom middleware support

- [x] static files serving

- [x] common response predefined (gemini, json, not found, etc.)

- [-] documentation

  - [-] README

  - [x] in code documentation

  - [-] guides and instructions

- [x] advanced work with client certificates

- [x] telemetry

- [x] template support

  - [x] Gemini files

  - [x] ANSI files (maybe?)

  - [x] other MIME types?

- [ ] session tracking based on client certificate

- [ ] easy statistics for servers (number of visits, etc.)

- [ ] easy to use testing framework

- [ ] hot code reload

## Contributing

If you have any problem (aka bug) with the code or feature request feel to fill

ticket at . Just don't expect I will

answer or fix the ticket - I have job and family, this is just hobby I do late

at night.

If you have any code you would like to include in the framework feel free to

send me patch at [[email protected]](mailto:[email protected]). And again don't

expect I will answer quickly. Please send patches as attachments not in

the email body (you will increase the chance I will be able to apply the patch

easily).

If you want to use part or all of my code and do anything with it - do what the

fuck you want. I don't care - if I would care I wouldn't put it publicly on the

internet.