Comienza a usar Firebase Data Connect con React

En esta guía de inicio rápido, crearás e implementarás una pequeña base de datos de muestra y accederás a ella desde un frontend de React.

Requisitos previos

Para completar este inicio rápido, necesitarás lo siguiente:

  • Un entorno de Node.js con NPM
  • Una Cuenta de Google

Instructivo

Instructivo

1. Crear un proyecto de Firebase nuevo

Comienza por crear un proyecto de Firebase nuevo en la consola de Firebase. Luego, actualiza el proyecto al plan Blaze.

2. Inicializa el proyecto

Crea un directorio nuevo y, luego, inicializa un proyecto de Firebase en él. Cuando se te solicite, elige las siguientes opciones:

  • Elige el proyecto que creaste en el paso anterior.
  • No crees un esquema con Gemini (en este instructivo, usarás un esquema de ejemplo prediseñado).
  • Crea una nueva instancia de Cloud SQL.
  • Crea una plantilla de React.
 
npx -y firebase-tools@latest login --reauth
npx -y firebase-tools@latest init dataconnect

3. Revisa las definiciones de ejemplo de GraphQL.

En Data Connect, defines todos los esquemas y las operaciones de tu base de datos con GraphQL. Cuando inicializaste tu proyecto, la CLI de Firebase creó algunas definiciones de ejemplo para que comiences.

 dataconnect/schema/schema.gql (fragmento) 
type Movie @table {
  title: String!
  imageUrl: String!
  genre: String
}

type MovieMetadata @table {
  movie: Movie! @unique
  rating: Float
  releaseYear: Int
  description: String
}
 dataconnect/example/queries.gql (excerpt) 
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

4. Implementa tus esquemas y operaciones

Cada vez que realices cambios en los esquemas, las consultas o las mutaciones de tu base de datos, debes implementarlos para que los cambios se apliquen en la base de datos.

 
npx -y firebase-tools@latest \
    deploy --only dataconnect

5. Propaga la base de datos con datos de muestra

Estos datos iniciales te permitirán tener algo que observar cuando pruebes la app de ejemplo. Ten en cuenta que, en este paso, ejecutarás GraphQL arbitrario, lo que se permite para las tareas administrativas.

 
npx -y firebase-tools@latest \
    dataconnect:execute dataconnect/seed_data.gql

6. Genera un SDK de cliente de JavaScript

Este comando usa tus definiciones de GraphQL para generar una biblioteca de JavaScript específicamente para tu base de datos, completa con definiciones de tipos. Usas esta biblioteca en tu app cliente para realizar todas las operaciones de la base de datos.

Puedes generar bibliotecas para varias plataformas, como Kotlin para Android, Swift para iOS y Flutter, agregando definiciones a connector.yaml.

 
npx -y firebase-tools@latest \
    dataconnect:sdk:generate
 SDK de React generado automáticamente (fragmento) 
export interface ListMoviesData {
  movies: ({
    id: UUIDString;
    title: string;
    imageUrl: string;
    genre?: string | null;
  } & Movie_Key)[];
}

export function useListMovies(
  options?: useDataConnectQueryOptions&<ListMoviesData>
): UseDataConnectQueryResult&<ListMoviesData, undefined>;

7. Configura una app web

Ejecuta estos comandos para agregar una nueva app web a tu proyecto de Firebase.

 
npx -y firebase-tools@latest \
    apps:create web react-example
npx -y firebase-tools@latest \
    apps:sdkconfig web -o web-app/src/firebase-config.json
cd web-app ; npm i firebase ; cd ..

8. Escribe un cliente de muestra de React

Reemplaza el contenido de web-app/src/App.jsx con esta sencilla app de React.

Observa que la app completa el acceso a la base de datos necesario con una función del SDK generado. El SDK generado para React usa TanStack Query para controlar la administración del estado.

 
import { initializeApp } from 'firebase/app';
import firebaseConfig from './firebase-config.json';
import {
  QueryClient,
  QueryClientProvider
} from '@tanstack/react-query';

import { useListMovies } from '@dataconnect/generated/react';
import './App.css';

const app = initializeApp(firebaseConfig);
const queryClient = new QueryClient();

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <Movies />
    </QueryClientProvider>
  );
}

function Movies() {
  const { isLoading, data } = useListMovies();
  if (isLoading) {
    return <h1>...</h1>
  }
  return (
    <>
      {data?.movies.map(
        movie => <h1 key={movie.id}>{movie.title}</h1>
      )}
    </>
  );
}

export default App;

9. Probar la app web

Inicia el servidor de desarrollo para ver la app de ejemplo en acción.

 
npm run dev

Próximos pasos

Prueba la extensión de Visual Studio Code

Cuando desarrolles con Data Connect, te recomendamos que uses la extensión de Visual Studio Code. Incluso si no usas Visual Studio Code como tu entorno de desarrollo principal, la extensión proporciona varias funciones que facilitan el desarrollo de esquemas y operaciones:

  • Un servidor de lenguaje GraphQL que proporciona sugerencias de autocompletar y verificación de sintaxis específicas para Data Connect
  • Botones de CodeLens en línea con tu código que te permiten leer y escribir datos desde tus archivos de definición de esquema, y ejecutar consultas y mutaciones desde tus definiciones de operación.
  • Mantén automáticamente sincronizados los SDKs generados con tus definiciones de GraphQL.
  • Configuración simplificada del emulador local
  • Implementación simplificada en producción

Usa el emulador Data Connect para el desarrollo local

Si bien en este instructivo se mostró cómo implementar esquemas y operaciones de Data Connect directamente en producción, es probable que no desees realizar cambios en tu base de datos de producción mientras desarrollas tu app de forma activa. En cambio, configura el emulador de Data Connect y realiza tu trabajo de desarrollo en él en lugar de en producción. El emulador configura una instancia local de PGlite que se comporta de manera similar a una instancia activa de Postgres en Cloud SQL.

Aprende a escribir esquemas y operaciones para tu app

Cuando desarrolles apps con Data Connect, el diseño de tus esquemas y operaciones será una de las primeras y más importantes tareas de desarrollo que completarás.

  • Gemini en Firebase console es una herramienta de IA que puede generar esquemas de Data Connect a partir de una descripción en lenguaje natural de tu app. Esta herramienta puede ayudarte a comenzar muy rápido, en especial si nunca trabajaste con bases de datos relacionales.
  • También puedes escribir esquemas de bases de datos, consultas y mutaciones directamente con GraphQL. Comienza con la página Diseña esquemas de Data Connect y continúa con las páginas de seguimiento para aprender a escribir operaciones.