README.md

Orange Portfólio - SQUAD 5

Somos o Squad 5 e esse é o nosso Orange Portfólio! Uma plataforma que permite aos usuários cadastrar e exibir projetos desenvolvidos.

🍊 Hackathon Orange Juice:

Este projeto foi uma realização do Hackthon do Programa de Formação da Orange Juice.

🖥️ Confira o site

🖼️ Screenshots

DESKTOP

• Adicionar Projeto

MOBILE

• Adicionar Projeto

🔧 Stacks utilizadas

Front-end:

• 
• 
• 
• 

Back-end:

• 
• 

🧱 Arquitetura

🚧 Dependências e Versões

• Express (Versão: 4.18.2)
• Firebase (Versão: 10.8.0)
• React-Firebase-Hooks (Versão: 5.1.1)
• React-Hook-Form (Versão: 7.49.3)
• React-Icons (Versão: 5.0.1)
• React-Router-Dom (Versão: 6.21.3)
• Styled-Components (Versão: 6.1.8)

Dependências opcionais

• Swagger-UI-Express (Versão: 5.0.0)
• Swagger-UI-React (Versão: 5.11.2)

⚙️ Rodando Localmente

Instale o Orange Portfólio com npm, seguindo os seguintes passos:

• Baixar a node modules:

npm install

• Instalar o firebase:

npm install firebase

• Rodar o projeto:

npm run dev

💼 Colaboradoras

---- Daiane Porcena ---

---- Graziela Felix ----

---- Isaballa Tiemy ----

---- Olga Mendes ----

---- Vanessa Ruiz ----

📚 Documentação e Protótipo

• Protótipo

• Documentação da API:

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "REST API",
    "description": ""
  },
  "host": "localhost:5173",
  "basePath": "/",
  "schemes": [
    "http"
  ],
  "paths": {
    "/projects/{id}": {
      "get": {
        "description": "",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  }
}