README.md

Pass.In - NLW 15 - Unite (NodeJs)

Essa é a aplicação Back-End com NodeJS desenvolvida durante o NLW 15 Unite da Rocketseat.

O Pass.In é uma aplicação de gestão de participantes em eventos presenciais.

A ferramenta permite que o organizador cadastre um evento e abra uma página pública de inscrição.

Os participantes inscritos podem emitir uma credencial para check-in no dia do evento.

O sistema fará um scan da credencial do participante para permitir a entrada no evento.

Requisitos

Requisitos funcionais

• O organizador deve poder cadastrar um novo evento;
• O organizador deve poder visualizar dados de um evento;
• O organizador deve poser visualizar a lista de participantes;
• O participante deve poder se inscrever em um evento;
• O participante deve poder visualizar seu crachá de inscrição;
• O participante deve poder realizar check-in no evento;

Regras de negócio

• O participante só pode se inscrever em um evento uma única vez;
• O participante só pode se inscrever em eventos com vagas disponíveis;
• O participante só pode realizar check-in em um evento uma única vez;

Requisitos não-funcionais

• O check-in no evento será realizado através de um QRCode;

Documentação da API (Swagger)

Para documentação da API, acesse o link: https://passin-api.onrender.com/docs

Banco de dados

Nessa aplicação vamos utilizar banco de dados relacional (SQL). Para ambiente de desenvolvimento seguiremos com o PostGresSQL.

Diagrama ERD

Estrutura do banco (PostGresSQL)

-- CreateTable
CREATE TABLE "events" (
    "id" TEXT NOT NULL,
    "title" TEXT NOT NULL,
    "slug" TEXT NOT NULL,
    "details" TEXT,
    "maximum_attendees" INTEGER,

    CONSTRAINT "events_pkey" PRIMARY KEY ("id")
);

-- CreateTable
CREATE TABLE "attendees" (
    "id" SERIAL NOT NULL,
    "name" TEXT NOT NULL,
    "email" TEXT NOT NULL,
    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "event_id" TEXT NOT NULL,

    CONSTRAINT "attendees_pkey" PRIMARY KEY ("id")
);

-- CreateTable
CREATE TABLE "check_ins" (
    "id" SERIAL NOT NULL,
    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "attendee_id" INTEGER NOT NULL,

    CONSTRAINT "check_ins_pkey" PRIMARY KEY ("id")
);

-- CreateIndex
CREATE UNIQUE INDEX "events_slug_key" ON "events"("slug");

-- CreateIndex
CREATE UNIQUE INDEX "attendees_event_id_email_key" ON "attendees"("event_id", "email");

-- CreateIndex
CREATE UNIQUE INDEX "check_ins_attendee_id_key" ON "check_ins"("attendee_id");

-- AddForeignKey
ALTER TABLE "attendees" ADD CONSTRAINT "attendees_event_id_fkey" FOREIGN KEY ("event_id") REFERENCES "events"("id") ON DELETE CASCADE ON UPDATE CASCADE;

-- AddForeignKey
ALTER TABLE "check_ins" ADD CONSTRAINT "check_ins_attendee_id_fkey" FOREIGN KEY ("attendee_id") REFERENCES "attendees"("id") ON DELETE CASCADE ON UPDATE CASCADE;

Complementos

Para esse evento de múltiplas tecnologias que se integram, um link complementar com todas os matérias.

Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---