Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henriquestocco/pass-in-nlw
Projeto construido na semana do NLW da Rocketseat.
https://github.com/henriquestocco/pass-in-nlw
Last synced: about 1 month ago
JSON representation
Projeto construido na semana do NLW da Rocketseat.
- Host: GitHub
- URL: https://github.com/henriquestocco/pass-in-nlw
- Owner: HenriqueStocco
- Created: 2024-04-06T11:51:20.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-04-15T21:47:42.000Z (8 months ago)
- Last Synced: 2024-04-15T23:22:55.228Z (8 months ago)
- Language: TypeScript
- Size: 110 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Projeto pass.in - Next Level Week(NLW): Rockeseat
## Sobre o projeto
E uma aplicaçao de **gestão de participantes em eventos presenciais**. A ferramenta ira permitir que o organizador cadastre um evento e
abra uma pagina de inscriçao, e os participantes inscritos no evento podem emitir uma credencial para checkin no dia do
evento. O sistema fara um scan da credencial usando QRCode, permitindo a entrada do participante 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;
## Tecnologias
- **Node.js >= v20.10.0**
- **NPM >= v10.2.5**
- **Fastify >= v4.26.x**
- **Zod >= v3.22.4**
- **TypeScript >= v5.4.4**
- **Prisma >= v5.12.1**
- **fastify-type-provider-zod**
## Documentaçao da API (Swagger)
**fastify-swagger >= v8.14.0**
Para documentação da API. Acessar: http://localhost:3333/docs
## Banco de dados
**SQLite >= v3.45.2**
Nessa aplicação utilizamos o banco de dados ralacional (SQL). Para o desenvolvimento seguimos com o SQLite pela facilidade do ambiente.
## Diagrama ER
## Como utilizar a aplicação
### E necessario ter o Node.js e o Git instalado
- Criar uma pasta para o projeto
```bash
~ mkdir project
```
- Clonar o projeto na pasta
```bash
project > git clone
```
- Instalar as dependencias
```bash
project/pass-in-NLW > npm i
```
- Definir configuraçoes do TypeScript
Pesquisar pela versao do Node e colar no arquivo `tsconfig.json`: https://github.com/tsconfig/bases
```bash
project/pass-in-NLW > npx tsc --init
```
- Iniciar o prisma e definir o banco de dados
```bash
project/pass-in-NLW > npx prisma init --datasource-provider SQLite
```
- Migrar as tebelas do banco de dados
```bash
project/pass-in-NLW > npm run db:migrate
```
- Utilizar a aplicação
```bash
project/pass-in-NLW > npm run dev
```
- Para ver os dados no banco de dados
```bash
project/pass-in-NLW > npm run db:studio
```