coderockr / vitrine-social Goto Github PK

View Code? Open in Web Editor NEW

74.0 11.0 19.0 3.75 MB

O classificado de doações

Home Page: https://www.vitrinesocial.org/

HTML 0.55% CSS 14.68% JavaScript 47.04% Makefile 1.25% Go 34.87% Shell 0.19% TSQL 1.42%

donations golang react

vitrine-social's Introduction

Vitrine Social

Issues e Progresso

O controle das tarefas e do progresso das mesmas estão sendo feitas no Waffle. Clique aqui para acompanhar: https://waffle.io/Coderockr/vitrine-social

Instalação Backend (Go)

Estamos utilizando Go Modules nesse projeto, por isso a pasta do projeto precisa ficar fora do seu GOPATH, ou terá que adicionar a ENV GO111MODULE como on em seu ambiente para que o projeto funcione dentro do GOPATH.

Recomendamos manter o projeto fora do seu GOPATH, assim o go não vai gerar um módulo sem necessidade na raiz do projeto, ou afetar outros projetos go em seu ambiente que ainda não estejam utilizando Go Modules.

Resumo da ópera, para começar a trabalhar basta rodar os seguintes comandos:

git clone [email protected]:Coderockr/vitrine-social.git /not/your/go/path/vitrine-social;

make setup # executar na primeira vez para instalar todas as dependencias e ferramentas

make migrations # isso pode falhar por causa do warmup do postgres

make serve # agora esta rodando :)

Instalando ambiente de desenvolvimento backend no Docker

Na primeira vez que for utilizar o projeto execute o comando:

make setup-on-docker

Após o comando concluir e nas próximas vezes precisa apenas:

make migrations-on-docker
make serve-on-docker

O terminal estará bloqueado durante a execução do backend

Domínios e Subdomínios locais

Incluir os seguintes domínios no seu /etc/hosts deve agilizar o setup do seu projeto:

127.0.0.1 api.vitrinesocial.test # usar porta 8000 (golang)
127.0.0.1 images.vitrinesocial.test # usar porta 7000 (images-server)
127.0.0.1 minio.vitrinesocial.test # usar porta 9000 (minio)
127.0.0.1 vitrinesocial.test # usar porta 3000 (frontend)

Instalação Frontend (React)

cd frontend

yarn

yarn start

Reicons

Mover ícones para assets/icons

yarn reicons

Comandos Auxiliares (dia-a-dia)

Estamos mantendo todos os comandos auxiliares (criar migration, rodar migrations, regerar docs, etc) dentro do Makefile na raiz do projeto.

Para ver quais são os comandos disponívels execute: make help e todos serão listados.

Documentação API

Para acessar a versão mais recente da definição acesse:

http://coderockr.com/vitrine-social/

Como atualizar a documentação?

Contribuindo

Leia o nosso CONTRIBUTING.md para aprender sobre o nosso processo de desenvolvimento, como propor bugfixes e melhorias, e como encontrar issues para atuar.

vitrine-social's People

Contributors

Stargazers

Watchers

Forkers

thallysrc felipecaputo eminetto marcosinger samuelssantos andrewsmedina leonascimento henriqueholanda hfxc-zz huydeerpets ederrr devbage esterfania delta94 dinosaulo

vitrine-social's Issues

Pesquisa de Necessidades

Search [/search?text={text}&category={categories}&org={org}&page={page}]

Fazer busca [GET]

Parameters
- text: texto a ser pesquisado (string, optional) - Texto a ser pesquidado
- categories: 1,2,3 (string, optional) - Ids das categorias
- org: 1 (number, optional) - Id da entidade para filtrar
- page: 1 (number, optional) - Paginação (vai trazer sempre 10 por página)

Request Busca das necessidades

Headers

  Accept: application/json
  Content-Type: application/json

Response 200 (application/json)
- Attributes (array[BaseNeed])

Logout

Logout [/auth/logout]

Realizar logout [POST]

Request Logout
- Headers
  Accept: application/json
  Content-Type: application/json
  Authorization: JWT
Response 204

Ajustar o app.css

Criar uma Necessidade

Criar [/need]

Criar Need [POST]

Request Criar

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Attributes (NeedPayload)

Response 201 (application/json)
- Attributes (Created)
Response 400 (application/json)
- Attributes (Error)

Definição do Scopo

Scopo Inicial do MVP

Definir hospedagem

Talvez pedir para algum fornecedor de hospedagem patrocinar?

Implementar modal de nova solicitação

Implementação do storage para arquivos

What is the objective?

Implementar storage para subir arquivos no S3.

Be careful on ...

Rever handler DeleteOrganizationImage para remover o arquivo do storage também.

Retornar Detalhes de uma Necessidade

Necessidade [/need/{id}]

Dados da necessidade [GET]

Parameters
- id (number) - Id da necessidade
Response 200 (application/json)
- Attributes (Need)
Response 404 (application/json)
- Attributes (Error)

Modelagem do backend

Implementar o frontend da Home

Implementar edição do perfil da organização

Serviço de autorização

related to #35

Boilerplate do backend

Adicionar uma imagem a Organização

Upload [/organization/{id}/upload]

Fazer upload [POST]

Parameters
- id (number) - Id da ONG

Request Upload de um arquivo

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Attributes (UploadFile)

Response 201 (application/json)
- Attributes (Created)
Response 400 (application/json)
- Attributes (Error)

Se inscrever para notificações da Organização

Subscribe [/organization/{id}/subscribe]

Receber notificações [POST]

Parameters
- id (number) - Id da ONG
Request
- Attributes
  - email (string) - E-mail
  - name (string) - Nome
  - phone (string) - Telefone
Response 204 (application/json)
Response 404 (application/json)
- Attributes (Error)

Criar servidor e CI

Parar de receber notificações sobre Organização

Unsubscribe [/organization/{id}/unsubscribe/{email}]

Parar de receber notificações [GET]

Parameters
- id (number) - Id da ONG
- email (string) - E-mail
Response 204 (application/json)
Response 404 (application/json)
- Attributes (Error)

Adicionar Imagem a uma Necessidade

Upload [/need/{id}/upload]

Fazer upload [POST]

Parameters
- id (number) - Id da necessidade

Request Upload de um arquivo

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Attributes (UploadFile)

Response 201 (application/json)
- Attributes (Created)
Response 400 (application/json)
- Attributes (Error)

Ajustes no scopo de classes css dos componentes

Definir nome do projeto

Implementar tela de login

Final Categories

Remover imagem de uma Necessidade

Remover imagem [/need/{id}/image/{image_id}]

Remover imagem [DELETE]

Parameters
- id (number) - Id da necessidade
- image_id (number) - Id da imagem

Request

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Response 204
Response 400 (application/json)
- Attributes (Error)

Implementar visualização das imagens da galeria

Documentação da api

Usando o api blueprint

Responder a uma necessidade [POST]

requires #45

Response [/need/{id}/response]

Responder a uma necessidade [POST]

Parameters
- id (number) - Id da necessidade
Request
- Attributes
  - email (string) - E-mail
  - name (string) - Nome
  - phone (string) - Telefone
  - address (string) - Endereço
  - message (string) - Mensagem enviada para a ONG
Response 204 (application/json)
Response 404 (application/json)
- Attributes (Error)

cli interno para incluir organizações

Criar um cliente simples para incluir organizações no banco de dados após aprovadas

Login

Login [/auth/login]

Realizar login [POST]

Request Login
- Headers
  Accept: application/json
  Content-Type: application/json
- Attributes (Login)
Response 200 (application/json)
- Attributes
  - organization (BaseOrganization)
  - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ (string)
Response 404 (application/json)
- Attributes (Error)

Remover uma Imagem da Organização

Remover imagem [/organization/{id}/image/{image_id}]

Remover imagem [DELETE]

Parameters
- id (number) - Id da ONG
- image_id (number) - Id da imagem

Request

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Response 204
Response 400 (application/json)
- Attributes (Error)

Implementar componente do modal

Add Prototype Categories

Boilerplate do frontend

Atualizar Organização

Organização [/organization/{id}]

Atualizar ONG [PUT]

Parameters
- id (number) - Id da ONG
Request Atualizar
- Headers
  Accept: application/json
  Content-Type: application/json
  Authorization: JWT
- Attributes (DetailedOrganization)
Response 204 (application/json)
Response 400 (application/json)
- Attributes (Error)

Implementar menu responsivo

Retornar Perfil da Organização

Organização [/organization/{id}]

Perfil da ONG [GET]

Parameters
- id (number) - Id da ONG
Response 200 (application/json)
- Attributes (DetailedOrganization)
Response 404 (application/json)
- Attributes (Error)

Adicionar unidade na necessidade

A Organização deve definir qual é a unidade que está precisando (kg, pessoas)

Modelagem da base de dados

Component Categories Home

Configurar o ESLint

Atualizar Senha

POST /v1/auth/update-password
Example URI: POST http://api.vitrine.dev:8001/v1/v1/auth/update-password

Request Atualizar SenhaHide

Headers

Accept: application/json
Content-Type: application/json
Authorization: JWT

Body

{
  "currentPassword": "123",
  "newPassword": "1234"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currentPassword": {
      "type": "string",
      "description": "Senha Atual"
    },
    "newPassword": {
      "type": "string",
      "description": "Nova Senha"
    }
  }
}

Response 200

Response 400

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Hello, world!"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    }
  }
}

Implementar carrossel de imagens no modal de detalhes

ajustar overflow

Implementar o modal de detalhes da requisição de doação

Carrossel de imagens foi para #79

Criar migrations/fixtures

Para pre-carregar os dados e facilitar as migrações de dados

Atualizar uma Necessidade

Necessidade [/need/{id}]

Atualizar Need [PUT]

Parameters
- id (number) - Id da necessidade

Request Atualizar

Headers

  Accept: application/json
  Content-Type: application/json
  Authorization: JWT

Attributes (NeedPayload)

Response 204 (application/json)
Response 400 (application/json)
- Attributes (Error)

coderockr / vitrine-social Goto Github PK

vitrine-social's Introduction

Vitrine Social

Issues e Progresso

Instalação Backend (Go)

Instalando ambiente de desenvolvimento backend no Docker

Domínios e Subdomínios locais

Instalação Frontend (React)

Reicons

Comandos Auxiliares (dia-a-dia)

Documentação API

vitrine-social's People

Contributors

Stargazers

Watchers

Forkers

vitrine-social's Issues

Search [/search?text={text}&category={categories}&org={org}&page={page}]

Fazer busca [GET]

Logout [/auth/logout]

Realizar logout [POST]

Criar [/need]

Criar Need [POST]

What is the objective?

Be careful on ...

Necessidade [/need/{id}]

Dados da necessidade [GET]

Upload [/organization/{id}/upload]

Fazer upload [POST]

Subscribe [/organization/{id}/subscribe]

Receber notificações [POST]

Unsubscribe [/organization/{id}/unsubscribe/{email}]

Parar de receber notificações [GET]

Upload [/need/{id}/upload]

Fazer upload [POST]

Remover imagem [/need/{id}/image/{image_id}]

Remover imagem [DELETE]

Response [/need/{id}/response]

Responder a uma necessidade [POST]

Login [/auth/login]

Realizar login [POST]

Remover imagem [/organization/{id}/image/{image_id}]

Remover imagem [DELETE]

Organização [/organization/{id}]

Atualizar ONG [PUT]

Organização [/organization/{id}]

Perfil da ONG [GET]

Request Atualizar SenhaHide

Response 200

Response 400

Necessidade [/need/{id}]

Atualizar Need [PUT]

Recommend Projects

Recommend Topics

Recommend Org