# GcIndexRelay

## Getting Started

Start the Apache AGE Docker container:

```bash
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`](http://localhost:4000) from your browser.

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

## 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:

```bash
mix ecto.gen.migration <migration-name>
```

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

```bash
mix ecto.migrate
```

Refer to the Fly.io guide [Safe Ecto Migrations](https://github.com/fly-apps/safe-ecto-migrations) for additional information.

## Learn more

- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix