lucky

Das Ziel: Verhindern Sie Fehler, vergessen Sie die meisten Leistungsprobleme und verbringen Sie mehr Zeit mit Code, anstatt Tests zu debugieren und zu beheben.

Zusammenfassend lassen Sie sich schnell, unterhaltsam und einfach das Schreiben von atemberaubenden Webanwendungen machen.

Von Rails kommen?

• Ruby on Rails to Lucky on Crystal: Schnell, weniger Käfer und noch mehr Spaß.

Versuchen Sie Glück

Lucky hat eine frische neue Reihe von Führern, die es einfach machen, loszulegen.

Fühlen Sie sich frei, Hallo zu sagen oder Fragen in unserem Chatraum zu stellen.

Oder Sie können eine echte arbeitende App mit Lucky Jumpstart kopieren.

Lucky installieren

Um Lucky zu installieren, lesen Sie die Installation Lucky Guides für Ihr Betriebssystem. Die Anleitung führt Sie durch die Installation eines Befehlszeilendienstprogramms zur Generierung neuer Glücksanwendungen.

Auf dem Laufenden halten

Bleiben Sie auf dem Laufenden, indem Sie @LuckyFramework auf Twitter folgen.

Dokumentation

API (Haupt)

Wie sieht es aus?

JSON -Endpunkt:

 class Api::Users::Show < ApiAction
  get " /api/users/:user_id " do
    user = UserQuery .find(user_id)
    json UserSerializer .new(user)
  end
end

• Wenn Sie möchten, können Sie benutzerdefinierte Routen wie get "/sign_in" für Nicht -Ruhestrouten einrichten.
• Eine user_id -Methode wird generiert, da ein user_id -Routenparameter vorhanden ist.
• Verwenden Sie json , um JSON zu rendern. Extrahieren Sie Serialisierer für wiederverwendbare JSON -Antworten.

Datenbankmodelle

 # Set up the model
class User < BaseModel
  table do
    column last_active_at : Time
    column last_name : String
    column nickname : String ?
  end
end

• Richtet die Spalten ein, die Sie gerne verwenden möchten, zusammen mit ihren Typen
• Sie können hinzufügen ? zu dem Typ, wenn die Spalte nil sein kann. Crystal hilft Ihnen dann, sich dann daran zu erinnern, keine Methoden anzurufen, die nicht funktionieren.
• Lucky wird Präsenzvalidierungen für die erforderlichen Felder einrichten ( last_active_at und last_name , da sie nicht als nilierbar gekennzeichnet sind).

Abfragen der Datenbank

 # Add some methods to help query the database
class UserQuery < User::BaseQuery
  def recently_active
    last_active_at.gt( 1 .week.ago)
  end

  def sorted_by_last_name
    last_name.lower.desc_order
  end
end

# Query the database
UserQuery .new.recently_active.sorted_by_last_name

• User::BaseQuery wird automatisch generiert, wenn Sie ein Modell definieren. Erben Sie davon, um Abfragen anzupassen.
• Richten Sie mit dem Namen Scopes mit Instanzmethoden ein.
• Lucky richtet Methoden für alle Spalten ein, sodass Sie bei der Kompilierungszeit, wenn Sie einen Spaltennamen befinden, bei der Kompilierung angeben.
• Verwenden Sie die lower Methode in einer String , um sicherzustellen, dass Postgres alles in Kleinbuchstaben sortiert.
• Verwenden Sie gt , um die Benutzer vor mehr als 1 Woche aktiv zu machen. Lucky hat viele leistungsstarke Abstraktionen für die Erstellung komplexer Abfragen und typen spezifische Methoden (wie lower ).

Rendern HTML:

 class Users::Index < BrowserAction
  get " /users " do
    users = UserQuery .new.sorted_by_last_name
    render IndexPage , users: users
  end
end

class Users::IndexPage < MainLayout
  needs users : UserQuery

  def content
    render_new_user_button
    render_user_list
  end

  private def render_new_user_button
    link " New User " , to: Users :: New
  end

  private def render_user_list
    ul class: " user-list " do
      users.each do | user |
        li do
          link user.name, to: Users :: Show .with(user.id)
          text " - "
          text user.nickname || " No Nickname "
        end
      end
    end
  end
end

• needs users : UserQuery teilt dem Compiler mit, dass er Benutzer des Typs UserQuery übergeben werden muss.
• Wenn Sie vergessen, etwas zu bestehen, das eine Seite benötigt, informiert Sie zur Kompilierzeit. Weniger Fehler und schnelleres Debuggen .
• Schreiben Sie Tags mit Kristallmethoden. Tags werden automatisch geschlossen und die Whitespace entfernt.
• Einfach benannte Methoden extrahieren, da Seiten aus regulären Klassen und Methoden bestehen. Dies macht Ihre HTML -Seiten unglaublich einfach zu lesen.
• Links zu anderen Seiten problemlos. Verwenden Sie einfach den Aktionsnamen: Users::New . Übergeben Sie Parameter with : Users::Show.with(user.id) . Sie versuchen nicht mehr, sich an Pfadhelfer zu erinnern und ob der Helfer pluralisiert oder nicht - wenn Sie vergessen, einen Param an eine Route zu übergeben, wird Lucky Sie zur Kompilierungszeit informieren.
• Seit wir column nickname : String? nil nilierbar würde Lucky die Seite nicht kompilieren, wenn Sie nur einen text user.nickname Stattdessen fügen wir einen Fallback "No Nickname" hinzu. Nicht versehentlich mehr leeren Text in HTML drucken!

Testen

Sie müssen sicherstellen, dass die Kristallabhängigkeiten installiert werden.

1. Führen Sie shards install
2. Führen Sie crystal spec aus der Projektwurzel aus.

Beitragen

Siehe Beitrag.md

Zum Glück, dich zu haben!

Wir lieben alle Community -Mitglieder, die harte Arbeit geleistet haben, um das Glück besser zu machen. Wenn Sie einer dieser Menschen sind, möchten wir Ihnen ein T-Shirt geben!

Um ein Shirt zu bekommen, bitten wir, dass Sie einen bedeutenden Beitrag zum Glück geleistet haben. Dies beinhaltet Dinge wie das Senden von PRs mit Fehlerbehebungen und Feature -Implementierungen, beim Durcharbeiten von Problemen und der Bereitstellung von Anwendungen in realer Welt mithilfe von Lucky!

Um Ihr Hemd zu beanspruchen, füllen Sie dieses Formular aus.

Mitwirkende

Paulcsmith Paul Smith - Originalschöpfer von Lucky

Mit Beitragsröcken gemacht.

Danke & Zuschreibungen

• SessionHandler, CookieHandler und FlashHandler basieren auf Amber. Vielen Dank an das Bernsteinteam!
• Vielen Dank an Rails für die Inspiration für viele der Ideen, die leicht für selbstverständlich ansehen können. Konvention über die Konfiguration, Entfernen von Kesselplatten und vor allem - konzentriert sich auf das Glück des Entwicklers.
• Dank an Phoenix, Ecto und Elixir für die Inspiration von Avrams Save Operations, Luckys einzelne Basisaktionen und -rohren und die Fokussierung auf hilfreiche Fehlermeldungen.
• lucky watch basiert stark auf Sentry. Danke @samueleaton!