jonathanmotta4 / nlw-unite-node

API para a aplicação Pass.in criada durante o evento NLW-Unite da Rocketseat, utilizando NodeJS, Prisma e Fastify

pass.in

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.

Utilização

• Clone este repositório
• Instale as dependências "npm install"
• Crie um arquivo .env na raiz do projeto contendo:

  DATABASE_URL="file:./dev.db"
  

• Execute o comando "npx prisma db seed" para adicionar algumas entradas no banco de dados
• Execute o comando "npm run dev" ou "npm run start" para iniciar a API

---

• (Opcional) Clone o repositório do Front-end da aplicação: Nlw-Unite-React

Documentação da API (Swagger)

Para documentação da API, acesse o link: https://nlw-unite-nodejs.onrender.com/docs

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;

Banco de dados

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

Estrutura do banco (SQL)

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

-- CreateTable
CREATE TABLE "attendees" (
    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
    "name" TEXT NOT NULL,
    "email" TEXT NOT NULL,
    "event_id" TEXT NOT NULL,
    "created_at" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
    CONSTRAINT "attendees_event_id_fkey" FOREIGN KEY ("event_id") REFERENCES "events" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
);

-- CreateTable
CREATE TABLE "check_ins" (
    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
    "created_at" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "attendeeId" INTEGER NOT NULL,
    CONSTRAINT "check_ins_attendeeId_fkey" FOREIGN KEY ("attendeeId") REFERENCES "attendees" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
);

-- 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_attendeeId_key" ON "check_ins"("attendeeId");