Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RevelryAI SDK Example App

A minimal Phoenix app for developing and testing the RevelryAI Elixir SDK (revelry_ai_ex) locally. The SDK is pulled in as a path dependency ({:revelry_ai, path: "../revelry_ai_ex"}), so SDK changes are picked up on recompile — no publishing or re-fetching needed.

Setup

mix setup
cp config/dev.secret.exs.example config/dev.secret.exs
# edit config/dev.secret.exs with your API key
mix phx.server

Then open http://localhost:4010.

Configuration

The SDK reads :revelry_ai application config. Two ways to set it:

  • config/dev.secret.exs (gitignored) — see config/dev.secret.exs.example
  • Env vars, which take precedence: REVELRY_AI_API_KEY, REVELRY_AI_API_URL

To test against a local RevelryAI instance (e.g. the main clone on port 4000):

REVELRY_AI_API_URL=http://localhost:4000 REVELRY_AI_API_KEY=... mix phx.server

What's here

RevelryAiExExampleWeb.SdkDemoLive (mounted at /) exercises the SDK:

  • Validate API key — RevelryAI.Validate.validate_api_key/1
  • List projects — RevelryAI.Project.list/1
  • Run a skill and await the result — RevelryAI.V2.Skill.run/4 + RevelryAI.V2.ApiJob.await/2

Add sections to the LiveView as new SDK features need exercising, or just use iex -S mix — the full SDK is available in the shell.

Ports

Per the workspace manifest (../CLAUDE.md): dev server on 4010 (override with PORT), test config uses 4008. Port 4002 is reserved for the main revelry_ai clone's test server — don't use it here.

Tests

mix test

No database — the app is generated with --no-ecto.

About

Example Phoenix app for developing the RevelryAI Elixir SDK (revelry_ai_ex)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages