https://github.com/soupaulodev/rocketseat-nlw-checkaqui

O CheckAqui é uma aplicação de gestão de participantes em eventos presenciais.
https://github.com/soupaulodev/rocketseat-nlw-checkaqui

fastify nodejs prisma typescript zod

Last synced: about 20 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/soupaulodev/rocketseat-nlw-checkaqui
• Owner: soupaulodev
• License: mit
• Created: 2024-04-02T01:37:58.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-04-04T03:51:46.000Z (8 months ago)
• Last Synced: 2024-11-14T22:17:54.112Z (about 20 hours ago)
• Topics: fastify, nodejs, prisma, typescript, zod
• Language: TypeScript
• Homepage: https://checkaqui.onrender.com/docs/static/index.html
• Size: 3.41 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
![Cover](./.github/cover.png)

# CheckAqui

O CheckAqui é 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

- [x] O organizador deve poder cadastrar um novo evento;

- [x] O organizador deve poder visualizar dados de um evento;

- [x] O organizador deve poser visualizar a lista de participantes;

- [x] O participante deve poder se inscrever em um evento;

- [x] O participante deve poder visualizar seu crachá de inscrição;

- [x] O participante deve poder realizar check-in no evento;

### Regras de negócio

- [x] O participante só pode se inscrever em um evento uma única vez;

- [x] O participante só pode se inscrever em eventos com vagas disponíveis;

- [x] O participante só pode realizar check-in em um evento uma única vez;

### Requisitos não-funcionais

- [x] 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://nlw-unite-nodejs.onrender.com/docs

## 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.

### Diagrama ERD



### Estrutura do banco (SQL)

```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" TEXT NOT NULL PRIMARY KEY,

    "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");

```

## Clonando e Rodando a Aplicação CheckAqui

### Pré-requisitos

Certifique-se de ter o Node.js e o npm (Node Package Manager) instalados em sua máquina.

### Crie e configure as variáveis de ambiente no arquivo .env na raiz do projeto

### Passo 1: Clonando o repositório

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório onde deseja clonar o repositório.

3. Execute o seguinte comando para clonar o repositório:

   




bashCopy code



git clone https://github.com/seu-usuario/checkaqui.git

   



### Passo 2: Configuração do Backend

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório do projeto clonado (`checkaqui/backend`).

3. Execute o comando para instalar as dependências do backend:

   




bashCopy code



npm install

   



4. No diretório `checkaqui/backend`, crie um arquivo chamado `.env` e adicione as seguintes variáveis de ambiente:

   




makefileCopy code



DATABASE_URL="sqlite:./dev.db"

   



5. No terminal, execute o comando para criar as tabelas e popular o banco de dados:

   




bashCopy code



npx prisma migrate dev --name init --preview-feature

   



6. Execute o seguinte comando para iniciar o servidor do backend:

   




bashCopy code



npm run dev

   



### Passo 3: Configuração do Frontend

1. Abra outro terminal ou prompt de comando.

2. Navegue até o diretório do frontend (`checkaqui/frontend`).

3. Execute o comando para instalar as dependências do frontend:

   




bashCopy code



npm install

   



4. Execute o seguinte comando para iniciar o servidor de desenvolvimento do frontend:

   




bashCopy code



npm start

   



5. Após o servidor iniciar com sucesso, abra o navegador e acesse `http://localhost:3000` para usar a aplicação CheckAqui.


### Passo 4: Documentação da API (Swagger)

1. Para acessar a documentação da API, abra o navegador e acesse o link:

   




bashCopy code



http://localhost:3000/docs



## Clonando e Rodando a Aplicação CheckAqui

### Pré-requisitos

Certifique-se de ter o Node.js e o npm (Node Package Manager) instalados em sua máquina.

### Passo 1: Clonando o repositório

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório onde deseja clonar o repositório.

3. Execute o seguinte comando para clonar o repositório:

   




bashCopy code



git clone https://github.com/seu-usuario/checkaqui.git

   



### Passo 2: Configuração do Backend

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório do projeto clonado (`checkaqui/backend`).

3. Execute o comando para instalar as dependências do backend:

   




bashCopy code



npm install

   



4. No diretório `checkaqui/backend`, crie um arquivo chamado `.env` e adicione as seguintes variáveis de ambiente:

   




makefileCopy code



DATABASE_URL="sqlite:./dev.db"

   



5. No terminal, execute o comando para criar as tabelas e popular o banco de dados:

   




bashCopy code



npx prisma migrate dev --name init --preview-feature

   



6. Execute o seguinte comando para iniciar o servidor do backend:

   




bashCopy code



npm run dev

   



### Passo 3: Configuração do Frontend

1. Abra outro terminal ou prompt de comando.

2. Navegue até o diretório do frontend (`checkaqui/frontend`).

3. Execute o comando para instalar as dependências do frontend:

   




bashCopy code



npm install

   



4. Execute o seguinte comando para iniciar o servidor de desenvolvimento do frontend:

   




bashCopy code



npm start

   



5. Após o servidor iniciar com sucesso, abra o navegador e acesse `http://localhost:3000` para usar a aplicação CheckAqui.


### Passo 4: Documentação da API (Swagger)

1. Para acessar a documentação da API, abra o navegador e acesse o link:

   




bashCopy code



http://localhost:3000/docs



## Clonando e Rodando a Aplicação CheckAqui

### Pré-requisitos

Certifique-se de ter o Node.js e o npm (Node Package Manager) instalados em sua máquina.

### Passo 1: Clonando o repositório

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório onde deseja clonar o repositório.

3. Execute o seguinte comando para clonar o repositório:

   




bashCopy code



git clone https://github.com/seu-usuario/checkaqui.git

   



### Passo 2: Configuração das variáveis de ambiente

1. Crie um arquivo `.env` na raiz do projeto.

   ```

   PORT=3000

   DATABASE_URL="file:./dev.db"

   ```

### Passo 3: Configuração do Backend

1. Abra o terminal ou prompt de comando.

2. Navegue até o diretório do projeto clonado (`checkaqui/backend`).

3. Execute o comando para instalar as dependências do backend:

   




bashCopy code



npm install

   



4. No terminal, execute o comando para criar as tabelas e popular o banco de dados:

   




bashCopy code



npx prisma migrate dev --name init

   



5. Execute o seguinte comando para iniciar o servidor do backend:

   




bashCopy code



npm run dev

   



### Passo 4: Configuração do Frontend

1. Abra outro terminal ou prompt de comando.

2. Navegue até o diretório do frontend (`checkaqui/frontend`).

3. Execute o comando para instalar as dependências do frontend:

   




bashCopy code



npm install

   



4. Execute o seguinte comando para iniciar o servidor de desenvolvimento do frontend:

   




bashCopy code



npm start

   



5. Após o servidor iniciar com sucesso, abra o navegador e acesse `http://localhost:3000` para usar a aplicação CheckAqui.


### Passo 5: Documentação da API (Swagger)

1. Para acessar a documentação da API, abra o navegador e acesse o link:

   




bashCopy code



http://localhost:3000/docs