silberengel
/
gc_index_relay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 Commits
2 Branches
0 Tags
1.1 MiB
 
 
 
 
 
 
Tree: a001d4168e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a001d4168e'
${ noResults }
buttercat1791 a001d4168e
Update precommit task with Credo 		2 months ago
config Fix unit test config 2 months ago
docker Specify database to connect to in PG setup script 2 months ago
lib Follow Credo refactor recommendations 2 months ago
priv Update code to pass tests 2 months ago
rel/overlays/bin Configure for local dev with Docker Compose 2 months ago
test Fix Credo warning 2 months ago
.dockerignore Organize for release builds and dev deployment 2 months ago
.formatter.exs Get Phoenix server up and running with Nostr Ecto context 3 months ago
.gitignore Configure for local dev with Docker Compose 2 months ago
AGENTS.md Add Elixir style rule with code example 2 months ago
CLAUDE.md Symlink CLAUDE.md to AGENTS.md 2 months ago
LICENSE.md Initial commit 3 months ago
README.md Initial commit 3 months ago
compose.yaml Configure for local dev with Docker Compose 2 months ago
mix.exs Update precommit task with Credo 2 months ago
mix.lock Add Credo to deps 2 months ago
prd-1-index-relay.md Produce Swagger schema for REST API 2 months ago

README.md

GcIndexRelay

Getting Started

Start the Apache AGE Docker container:

docker build \
  -t age \
  -f ./db/Dockerfile \
  ./db
docker run \
  -d \
  -p 5455:5432 \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=gc_index_relay_dev \
  age

To start your Phoenix server:

  • Run mix setup to install and setup dependencies
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

Project Overview

Database

  • The database stores Nostr events.
  • Nostr events, once signed, are considered to be immutable.

Migrations

After modifying an Ecto schema, generate a migration with:

mix ecto.gen.migration <migration-name>

Edit the generated migration file as needed, then perform the migration with:

mix ecto.migrate

Refer to the Fly.io guide Safe Ecto Migrations for additional information.

Learn more