Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Coderockr/vitrine-social
O classificado de doações
https://github.com/Coderockr/vitrine-social
donations golang react
Last synced: 3 months ago
JSON representation
O classificado de doações
- Host: GitHub
- URL: https://github.com/Coderockr/vitrine-social
- Owner: Coderockr
- Archived: true
- Created: 2017-08-14T19:27:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-05T15:03:52.000Z (about 2 years ago)
- Last Synced: 2024-07-18T20:43:00.179Z (4 months ago)
- Topics: donations, golang, react
- Language: JavaScript
- Homepage: https://www.vitrinesocial.org/
- Size: 3.66 MB
- Stars: 74
- Watchers: 11
- Forks: 19
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-social-projects - Vitrine social
README
Vitrine Social [![Codacy Badge](https://api.codacy.com/project/badge/Grade/5d73b7a4fb1b4118a8cb900e1ea91c49)](https://www.codacy.com/app/lucassabreu/vitrine-social?utm_source=github.com&utm_medium=referral&utm_content=Coderockr/vitrine-social&utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/Coderockr/vitrine-social.svg?branch=master)](https://travis-ci.org/Coderockr/vitrine-social) [![codecov](https://codecov.io/gh/Coderockr/vitrine-social/branch/master/graph/badge.svg)](https://codecov.io/gh/Coderockr/vitrine-social)
===============
[![Waffle.io - Columns and their card count](https://badge.waffle.io/Coderockr/vitrine-social.svg?columns=all)](https://waffle.io/Coderockr/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](https://github.com/golang/go/wiki/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:
```sh
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:
```sh
make setup-on-docker
```Após o comando concluir e nas próximas vezes precisa apenas:
```sh
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:
```sh
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)
```sh
cd frontendyarn
yarn start
```### Reicons
Mover ícones para assets/icons
```sh
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?](./CONTRIBUTING.md#atualize-a-documentação)
## [Contribuindo](./CONTRIBUTING.md)
Leia o nosso [CONTRIBUTING.md](./CONTRIBUTING.md) para aprender sobre o nosso processo de desenvolvimento, como propor bugfixes e melhorias, e como encontrar issues para atuar.