Write an actual README

main
Hugo Peixoto 10 months ago
parent ded65410d4
commit 5690f2d8a3
  1. 85
      README.md

@ -1,24 +1,83 @@
# README
# saucy
This README would normally document whatever steps are necessary to get the
application up and running.
Uma plataforma de gestão de sócies para associações. Desenvolvido e usado pela
[ANSOL - Associação Nacional para o Software Livre](https://ansol.org).
Things you may want to cover:
* Ruby version
## Licença
* System dependencies
saucy - Copyright (C) 2022 ANSOL
* Configuration
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.
* Database creation
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.
* Database initialization
See the LICENSE file for full details.
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
## Funcionalidades
* Deployment instructions
A plataforma tem o mínimo necessário para os requisitos da ANSOL:
* ...
- [x] Gestão da equipa da direçcão
- [x] Actualizar membros da direccao (desactivar, criar novos, etc)
- [x] Registar sócio (informação base, assumindo que falta o pagamento)
- [x] Endereço de email
- [x] Nome ("display name"/"preferred name")
- [x] Número de BI/CC/Passaporte
- [x] Morada completa, incluindo código postal/localidade
- [x] estudante/reformade/desempregade/empregade
- [x] Adicionar à mailing list?
- [x] Preferência de contacto: postal ou electrónico (comunicações das AGs)
- [x] Integração com ifthenpay para pagamento de quotas anuais
- [x] Lista de sócios, com filtros e ordenação
- [x] em cada sócio:
- [x] editar informacao base (incluindo end date)
- [x] poder registar nova contribuição, estendendo o end-date 1 ano
- [x] excluir sócio (eliminação de dados pessoais, mantendo historico de contribuições)
- [x] corrigir dados de/apagar contribuição
- [x] mandar lembretes de renovação de quotas, cada um com o seu texto
- [x] gestão de estado de inscrição automático:
- [x] pendente (pré-aprovação/pagamento)
- [x] activa (quotas em dia)
- [x] expirada (quotas expiradas)
- [x] excluída (90 dias após expiração / manualmente excluído)
## Contribuir
Obrigado pelo interesse em contribuir para o projecto `saucy`.
### Como reportar ou corrigir problemas
Se tiveres conta no git.ansol.org, basta criar um `Issue` ou `Pull Request` em
`https://git.ansol.org/ansol/saucy`. Caso não tenhas conta, envia um email para
`direccao@ansol.org` ou fala connosco na (sala de matrix comunitária da
ANSOL)[https://matrix.to/#/#geral:ansol.org]
### Traduções
As traduções existentes encontram-se em `config/locales/{pt,en}.yml`. Caso haja
alguma mensagem que não seja traduzível, fala connosco para corrigirmos o
problema (ver ponto anterior).
### Introduzir funcionalidades novas
Novas funcionalidades muito distantes dos casos de uso da ANSOL podem ser
recusadas, por isso recomendamos que fales connosco antes de começar uma
funcionalidade grande.
Funcionalidades que gostaríamos de implementar mas ainda não tivemos tempo:
- Parameterização do `saucy` de modo a não haver referências à ANSOL no código;
- "Multitenancy", onde uma única instalação do `saucy` permite servir várias
instituições;
- Melhorias genéricas ao estilo da plataforma.

Loading…
Cancel
Save