docs

.gitignore

@@ -0,0 +1,3 @@
+# Dir for bundles
+dist
+node_modules

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ivan Goncharov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -6,76 +6,76 @@ O projeto de NFT da comunidade Python Floripa visa desenvolver uma plataforma co
 
 ## Objetivos Principais
 
-1. **Capacitação dos membros:** Criar oportunidades para que desenvolvedores da comunidade Python Floripa aprendam e implementem soluções blockchain.  
-     
-2. **Conteúdo de referência:** Produzir documentação e conteúdo que sirvam como referência para a comunidade em geral.  
-     
-3. **Plataforma de NFTs:** Desenvolver uma plataforma de ponta a ponta que integre um provedor de blockchain, como Ethereum, para permitir o cadastro, resgate e validação de NFTs.  
-     
-4. **Aplicações práticas:** Criar soluções práticas como:  
-* Certificados de participação em eventos, gerados automaticamente com base no check-in dos participantes.  
+1. **Capacitação dos membros:** Criar oportunidades para que desenvolvedores da comunidade Python Floripa aprendam e implementem soluções blockchain.
+
+2. **Conteúdo de referência:** Produzir documentação e conteúdo que sirvam como referência para a comunidade em geral.
+
+3. **Plataforma de NFTs:** Desenvolver uma plataforma de ponta a ponta que integre um provedor de blockchain, como Ethereum, para permitir o cadastro, resgate e validação de NFTs.
+
+4. **Aplicações práticas:** Criar soluções práticas como:
+* Certificados de participação em eventos, gerados automaticamente com base no check-in dos participantes.
 * NFTs de cards para eventos e palestras, permitindo que participantes resgatem NFTs personalizados com base na sua presença.
 
-**Certificado de Participação via NFT**: Cada participante que fizer check-in em um evento da Python Floripa poderá resgatar um NFT como certificado digital, garantindo a autenticidade de sua participação.  
-**Cards NFT para eventos e palestras**: Cada evento ou atividade da comunidade terá um card digital vinculado a um NFT, que poderá ser resgatado por participantes após validação do check-in.  
+**Certificado de Participação via NFT**: Cada participante que fizer check-in em um evento da Python Floripa poderá resgatar um NFT como certificado digital, garantindo a autenticidade de sua participação.
+**Cards NFT para eventos e palestras**: Cada evento ou atividade da comunidade terá um card digital vinculado a um NFT, que poderá ser resgatado por participantes após validação do check-in.
 **Popularização da Blockchain**: Facilitar a compreensão e utilização da tecnologia blockchain por parte da comunidade e da sociedade em geral, aproximando os desenvolvedores da prática e fomentando a difusão desse conhecimento.
 
 ## Objetivos Específicos
 
-1. **Ferramenta para várias comunidades:** A plataforma será disponibilizada publicamente e poderá ser utilizada por outras comunidades interessadas, mediante a compra de créditos para cobrir os custos de infraestrutura, como o pagamento ao provedor de blockchain.  
-     
-2. **Desenvolvimento colaborativo:** Todo o código-fonte será desenvolvido de forma colaborativa e aberto no GitHub da comunidade Python Floripa.  
-     
-3. **Construção de autoridade:** Participantes diretos do desenvolvimento poderão adicionar suas contribuições ao projeto em seus portfólios, destacando sua participação para fins de progressão profissional.  
-     
+1. **Ferramenta para várias comunidades:** A plataforma será disponibilizada publicamente e poderá ser utilizada por outras comunidades interessadas, mediante a compra de créditos para cobrir os custos de infraestrutura, como o pagamento ao provedor de blockchain.
+
+2. **Desenvolvimento colaborativo:** Todo o código-fonte será desenvolvido de forma colaborativa e aberto no GitHub da comunidade Python Floripa.
+
+3. **Construção de autoridade:** Participantes diretos do desenvolvimento poderão adicionar suas contribuições ao projeto em seus portfólios, destacando sua participação para fins de progressão profissional.
+
 4. **Documentação e Live Weeklys:** O desenvolvimento será documentado e acompanhado por transmissões semanais ao vivo entre os membros do squad de desenvolvimento, para discutir a evolução, distribuir demandas e relatar a evolução do projeto. Essas lives serão disponibilizadas no YouTube da comunidade.
 
 ## Especificação Técnica
 
 ### Estrutura da Plataforma
 
-1. **Backend:** A plataforma será desenvolvida em Python, com integração a um provedor de blockchain (e.g., Ethereum). Será responsável por:  
-* Gerenciar o cadastro dos eventos e usuários.  
-* Verificar o check-in dos participantes nos eventos.  
-* Emitir e associar NFTs aos participantes.  
-    
-2. **Frontend:** Interface simples e amigável para permitir que os usuários façam o resgate dos NFTs gerados. O design será responsivo, permitindo fácil acesso em diferentes dispositivos.  
-     
-3. **Integração com Blockchain:** A plataforma terá integração com o blockchain escolhido (e.g., Ethereum) para a criação e validação dos NFTs. Utilizaremos smart contracts para garantir a segurança e transparência das transações.  
-     
+1. **Backend:** A plataforma será desenvolvida em Python, com integração a um provedor de blockchain (e.g., Ethereum). Será responsável por:
+* Gerenciar o cadastro dos eventos e usuários.
+* Verificar o check-in dos participantes nos eventos.
+* Emitir e associar NFTs aos participantes.
+
+2. **Frontend:** Interface simples e amigável para permitir que os usuários façam o resgate dos NFTs gerados. O design será responsivo, permitindo fácil acesso em diferentes dispositivos.
+
+3. **Integração com Blockchain:** A plataforma terá integração com o blockchain escolhido (e.g., Ethereum) para a criação e validação dos NFTs. Utilizaremos smart contracts para garantir a segurança e transparência das transações.
+
 4. **Banco de Dados:** Sistema de banco de dados para armazenar os eventos, usuários, e NFTs gerados, garantindo a rastreabilidade e segurança dos dados.
 
 ### Cronograma e Marcos do Projeto
 
-1. **Planejamento e Design** (prazo?):  
-* Definir os requisitos detalhados.  
-* Estruturar o backend e a integração com o blockchain.  
-* Prototipar a interface.  
-    
-2. **Desenvolvimento** (prazo?):  
-* Implementação do backend e frontend.  
-* Configuração da integração com o blockchain.  
-* Testes iniciais com a comunidade.  
-* Publicar documentação no GitHub.  
-    
-3. **Lançamento Beta** (prazo?):  
-* Disponibilizar a versão beta da plataforma para testes com os membros da comunidade.  
-    
-4. **Ajustes e Lançamento** (prazo?):  
-* Correção e ajustes de código.  
-* Realizar lives de apresentação da solução.  
-* Recrutar embaixadores para divulgar o projeto em eventos diversos.  
+1. **Planejamento e Design** (prazo?):
+* Definir os requisitos detalhados.
+* Estruturar o backend e a integração com o blockchain.
+* Prototipar a interface.
+
+2. **Desenvolvimento** (prazo?):
+* Implementação do backend e frontend.
+* Configuração da integração com o blockchain.
+* Testes iniciais com a comunidade.
+* Publicar documentação no GitHub.
+
+3. **Lançamento Beta** (prazo?):
+* Disponibilizar a versão beta da plataforma para testes com os membros da comunidade.
+
+4. **Ajustes e Lançamento** (prazo?):
+* Correção e ajustes de código.
+* Realizar lives de apresentação da solução.
+* Recrutar embaixadores para divulgar o projeto em eventos diversos.
 * Divulgação nas redes sociais e eventos da comunidade.
 
 ## Referencias
 
 **Benchmark**
-[https://poap.xyz/](https://poap.xyz/) 
+[https://poap.xyz/](https://poap.xyz/)
+
+**Ferramentas para Desenhar Arquitetura**
+draw.io
+[https://structurizr.com](https://structurizr.com/)
 
-**Ferramentas para Desenhar Arquitetura** 
-draw.io  
-[https://structurizr.com](https://structurizr.com/)  
-
 ## Comentários e Devaneios
 
 ## Requisitos funcionais
@@ -99,6 +99,4 @@ draw.io
   - certifica que participou das atividades do Eventos
 
 ## Requisitos não-funcionais
-- deploy na AWS (?)
-
-
+- deploy na AWS (?)

docs/.redocly.yaml

@@ -0,0 +1,26 @@
+# See https://redoc.ly/docs/cli/configuration/ for more information.
+extends:
+  - recommended
+apis:
+  core@v1:
+    root: ./openapi/openapi.yaml
+    rules:
+      no-ambiguous-paths: error
+    theme:
+      openapi:
+        hideLogo: false
+    decorators:
+      remove-x-internal: on
+rules:
+  no-unused-components: error
+  operation-singular-tag: warn
+  boolean-parameter-prefixes:
+    severity: error
+    prefixes: ["can", "is", "has"]
+theme:
+  openapi:
+    schemaExpansionLevel: 2
+    generateCodeSamples:
+      languages:
+        - lang: curl
+        - lang: Python

docs/index.html

@@ -0,0 +1,32 @@
+<html>
+
+<head>
+    <!-- Load the latest Swagger UI code and style from npm using unpkg.com -->
+    <script src="https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script>
+    <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@3/swagger-ui.css" />
+    <title>My New API</title>
+</head>
+
+<body>
+    <div id="swagger-ui"></div> <!-- Div to hold the UI component -->
+    <script>
+        window.onload = function () {
+            // Begin Swagger UI call region
+            const ui = SwaggerUIBundle({
+                url: 'https://github.com/dan5e3s6ares/nft/blob/docs/docs/openapi.yaml',
+                dom_id: '#swagger-ui',
+                deepLinking: true,
+                presets: [
+                    SwaggerUIBundle.presets.apis,
+                    SwaggerUIBundle.SwaggerUIStandalonePreset
+                ],
+                plugins: [
+                    SwaggerUIBundle.plugins.DownloadUrl
+                ],
+            })
+            window.ui = ui
+        }
+    </script>
+</body>
+
+</html>

docs/openapi.yaml

@@ -0,0 +1,174 @@
+openapi: 3.0.2
+info:
+  version: 1.0.0
+  title: NFT Python Floripa
+  termsOfService: https://example.com/terms/
+  contact:
+    email: [email protected]
+    url: http://example.com/contact
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  x-logo:
+    url: https://redocly.github.io/openapi-template/logo.png
+  description: |
+    NFT API Documentation.
+servers:
+  - url: https://pop.cloudman.pro
+tags:
+  - name: Cadastro
+    description: Example echo operations
+  - name: Certificado
+    description: Operations about user
+externalDocs:
+  description: Find out how to create a GitHub repo for your OpenAPI definition.
+  url: https://github.com/Rebilly/generator-openapi-repo
+paths:
+  /pop/Auth-pop:
+    post:
+      operationId: create_user
+      tags:
+        - Cadastro
+      summary: Create a new user
+      deprecated: false
+      description: Create a new user
+      requestBody:
+        description: User object that needs to be added to the system
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateUser'
+        required: true
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+            application/xml:
+              schema:
+                $ref: '#/components/schemas/User'
+        '400':
+          description: Invalid user supplied
+        '409':
+          description: User already exists
+  /pop/OrgAdmin-pop:
+    post:
+      operationId: create_certificate
+      tags:
+        - Certificado
+      summary: Create a new certificate
+      deprecated: false
+      description: Create a new certificate
+      requestBody:
+        description: Certificate object that needs to be added to the system
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateCertificate'
+        required: true
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CertificateCreated'
+            application/xml:
+              schema:
+                $ref: '#/components/schemas/CertificateCreated'
+        '409':
+          description: Item não encontrado na DynamoDB
+components:
+  securitySchemes:
+    main_auth:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: http://example.com/api/oauth/dialog
+          scopes:
+            read:users: read users info
+            write:users: modify or remove users
+    api_key:
+      type: apiKey
+      in: header
+      name: api_key
+    basic_auth:
+      type: http
+      scheme: basic
+  schemas:
+    User:
+      properties:
+        name:
+          description: User Name
+          type: string
+          minLength: 4
+          example: John Smith
+    Email:
+      properties:
+        email:
+          description: User email address
+          type: string
+          format: test
+          example: [email protected]
+    CreateUser:
+      type: object
+      title: Create User
+      description: Create a new user
+      required:
+        - name
+        - email
+        - action
+        - otp
+      allOf:
+        - $ref: '#/components/schemas/User'
+        - $ref: '#/components/schemas/Email'
+      properties:
+        action:
+          type: string
+          enum:
+            - verify
+            - register
+            - process-link
+          format: test
+          description: Action to be performed
+        otp:
+          type: string
+          example: '123456'
+          format: test
+          description: OTP code
+    Certificate:
+      properties:
+        orgName:
+          description: Organization name
+          type: string
+          format: test
+          example: Example Inc.
+        eventName:
+          description: Event name
+          type: string
+          format: test
+          example: Example Event
+    CreateCertificate:
+      type: object
+      title: Create User
+      description: Create a new user
+      required:
+        - orgName
+        - eventName
+      allOf:
+        - $ref: '#/components/schemas/Certificate'
+      properties:
+        action:
+          type: string
+          enum:
+            - StartCreateCerts
+          format: text
+          description: Action to be performed
+    CertificateCreated:
+      properties:
+        attendeeCounter:
+          description: Number of attendees
+          type: integer
+          format: int32