Add initial project structure with README, LICENSE, and .gitignore config

This commit is contained in:
2025-08-20 04:27:48 +01:00
commit 914f694dc4
3 changed files with 152 additions and 0 deletions

109
.gitignore vendored Normal file
View File

@@ -0,0 +1,109 @@
# Allowlisting gitignore template for GO projects prevents us
# from adding various unwanted local files, such as generated
# files, developer configurations or IDE-specific files etc.
#
# Recommended: Go.AllowList.gitignore
# Ignore everything
*
# Especially these
.vscode
.vscode/
.vscode/**
**/.vscode
**/.vscode/**
node_modules
node_modules/
node_modules/**
**/node_modules
**/node_modules/
**/node_modules/**
/test*
.idea
.idea/
.idea/**
/.idea/
/.idea/**
/.idea
# and others
/go.work.sum
/secp256k1/
# But not these files...
!/.gitignore
!*.go
!go.sum
!go.mod
!*.md
!LICENSE
!*.sh
!Makefile
!*.json
!*.pdf
!*.csv
!*.py
!*.mediawiki
!*.did
!*.rs
!*.toml
!*.file
!.gitkeep
!pkg/eth/**
!*.h
!*.c
!*.proto
!bundleData
!*.item
!*.bin
!*.yml
!*.yaml
!*.tmpl
!*.s
!*.asm
!.gitmodules
!*.txt
!*.sum
!pkg/version
!*.service
!*.benc
!*.png
!*.adoc
!*.js
!*.bash
!PATENTS
!*.css
!*.ts
!*.html
!Dockerfile
!*.lock
!*.nix
!license
!readme
!*.ico
!.idea/*
!*.xml
!.name
!.gitignore
!version
!out.jsonl
# ...even if they are in subdirectories
!*/
/blocklist.json
/gui/gui/main.wasm
/gui/gui/index.html
pkg/database/testrealy
/.idea/workspace.xml
/.idea/dictionaries/project.xml
/.idea/shelf/Add_tombstone_handling__enhance_event_ID_logic__update_imports.xml
/.idea/.gitignore
/.idea/misc.xml
/.idea/modules.xml
/.idea/orly.dev.iml
/.idea/vcs.xml
/.idea/codeStyles/codeStyleConfig.xml
/.idea/material_theme_project_new.xml
/.idea/orly.iml
/.idea/go.imports.xml
/.idea/inspectionProfiles/Project_Default.xml
/.idea/.name

24
LICENSE Normal file
View File

@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>

19
readme.adoc Normal file
View File

@@ -0,0 +1,19 @@
= next.orly.dev
:toc:
:note-caption: note 👉
image:https://img.shields.io/badge/godoc-documentation-blue.svg[Documentation,link=https://pkg.go.dev/next.orly.dev]
image:https://img.shields.io/badge/donate-geyser_crowdfunding_project_page-orange.svg[Support this project,link=https://geyser.fund/project/orly]
zap me: ⚡mlekudev@getalby.com
follow me on link:https://jumble.social/users/npub1fjqqy4a93z5zsjwsfxqhc2764kvykfdyttvldkkkdera8dr78vhsmmleku[nostr]
== about
ORLY is a nostr relay written from the ground up to be performant, low latency, and built with a number of features designed to make it well suited for
- personal relays
- small community relays
- business deployments and RaaS (Relay as a Service) with a nostr-native NWC client to allow accepting payments through NWC capable lightning nodes
- high availability clusters for reliability and/or providing a unified data set across multiple regions
ORLY uses a fast embedded link:https://github.com/hypermodeinc/badger[badger] database with a database designed for high performance querying and event storage.