Skip to content

README.md

Latest commit

 

History

History
59 lines (36 loc) · 1.9 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.9 KB
Raw

SF Ruby Cards 🎨☁️

AI-powered cloud character invitations for San Francisco Ruby Conference attendees. Upload a photo, get transformed into a whimsical cloud character over SF's skyline!


Evil Martians logo Built by Evil Martians, an American design and engineering consultancy for developer tools, AI, and cybersecurity startups.

Requirements

  • Ruby 3.4+
  • Google Gemini API key: Get one at https://ai.google.dev/
    • Put it into credentials as gemini.api_key or provide via the GEMINI_API_KEY env var.

Running locally

Install dependencies:

bin/setup

Run a web server along with the Vite dev server:

bin/dev

Go to localhost:3000 and check it out!

Running tests

We use RSpec to write tests. You can run them with:

bundle exec rspec

Note that system tests are excluded by default. You can run them as follows:

bundle exec rspec spec/system
# or
bundle exec rspec --tag type:system

Admin console

You can access our Avo admin console at: localhost:3000/admin.

The default admin username and password are admin and pass. You can update them in the credentials (app.admin_username and app.admin_password respectively).

Lookbook

We use Lookbook to work with UI (development, previews). All the code related to previews is stored under the lookbook/ fodler. The lookbook itself is available at: localhost:3000/dev/lookbook.

Working with emails

We use letter_opener_web to delivery and view emails in development. You can access the inbox at localhost:3000/dev/letters.