facto

Ferramenta de contabilidade familiar

A ferramenta de contabilidade familiar mantém o controle de todas as transações que sua família faz. Seu objetivo é:

• Extrair estatísticas úteis dos dados
  Por exemplo: quanto é gasto em comida a cada mês?
• Calcular a dívida interna
  Por exemplo: Alice compra papel higiênico para toda a família com seu próprio dinheiro. Essa ferramenta registra que a família deve à Alice o custo do papel higiênico.
• Forneça uma maneira de verificar se nenhum dinheiro está desaparecendo em despesas inesperadas
  Por exemplo: você notará quando houver custos bancários ocultos

Captura de tela

Instalação da liberação

• Instale o Java 11 (JDK 11) em seu servidor
• Faça o download "Binários (arquivos compilados) com configuração de demonstração" da versão mais recente
• Desembale o arquivo
• Open conf/application.conf na pasta Unpacked:
  • Configure um banco de dados. A maneira mais fácil é configurar um servidor Mariadb localmente, criar um banco de dados vazio chamado facto e configurá -lo da seguinte forma:

 db.default {
  driver = com.mysql.jdbc.Driver
  url = "jdbc:mysql://localhost/facto?user=mysqluser&password=mysqlpassword"
  slick.profile = "slick.jdbc.MySQLProfile$"
}

• Escolha valores secretos para play.http.secret.key e app.setup.defaultPassword

• Abra um terminal na pasta descompactada

• Execute os seguintes comandos para executar o aplicativo:

   # Create database tables
  bin/server -DdropAndCreateNewDb
  
  # Create admin user
  bin/server -DcreateAdminUser
  
  # Run application
  bin/server
  

• Navegue para http: // localhost: 9000/app/userAdministration (nome de usuário: "admin", senha: "changeMe")

Instalação com Docker (desanimado)

Aviso: o seguinte funciona bem para o lançamento de um servidor de demonstração para dar uma olhada. Mas se você deseja executar isso como um serviço com dados reais e configuração personalizada, é recomendável seguir a seção "Instalação da versão" (consulte este problema pelos motivos).

Os seguintes comandos lançarão um novo servidor juntamente com um banco de dados em contêineres do Docker:

 # Get the docker-compose.yml file
wget https://raw.githubusercontent.com/nymanjens/facto/master/docker-compose.yml

# Choose a unique random string here of sufficient length
export APPLICATION_SECRET="$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)"

# Create an empty database with a single admin user
docker-compose run web sleep 5 # Wait for the database to be ready
docker-compose run web bin/server -DdropAndCreateNewDb
docker-compose run web bin/server -DcreateAdminUser

# Bring up the server
docker-compose up

Quando terminar, navegue para http: // localhost: 9000/(nome de usuário: "admin", senha: "changeMe"))

Configuração

• conf/application.conf :
  Configure e configure um banco de dados aqui.
• Adicionar usuários:
  Um usuário padrão é criado com o sinalizador -DcreateAdminUser (nome de usuário: admin, senha: ChangeMe). Esta conta pode criar novos usuários.
• conf/accounting-config.yml :
  Edite este arquivo para refletir sua situação e preferências. Observe que userLoginName deve se referir a um usuário que já existe no banco de dados (consulte o ponto anterior)

Uso

Para usar efetivamente essa ferramenta, você deve aprender a inserir as transações corretamente. Portanto, é importante entender o significado de categorias e contas.

Categorias

Eles são usados ​​para dividir suas despesas em categorias. Cada conta tem algumas categorias especiais:

• Categoria contábil:
  Usado para receitas/despesas não reais. Esta categoria será ignorada ao analisar o superávit/déficit mensal em termos de despesas. Use esta categoria, por exemplo, quando a despesa será paga de volta pelo seu empregador
• Categoria de doação:
  Usado para transferência de dinheiro para a conta comum (veja o exemplo na próxima seção)

Contas

Uma conta pode se referir a uma pessoa comum ou à conta comum.

Exemplo:

Uma família tem dois membros: Alice e Bob. Haverá três contas:

• Alice
• Prumo
• A conta comum

Alice e Bob transferirão regularmente dinheiro para a conta comum, que pode ser usada para fazer despesas comuns. Esta transferência para a conta comum é chamada de 'doação' .

Inserção de transações

Campos especiais:

• Beneficiário:
  Em caso de despesa: aquele que se beneficiará da despesa
  Em caso de renda: aquele que foi pago
• Pago com/para:
  Em caso de despesa: pago com
  Em caso de renda: pago a
• Fluxo:
  Em caso de despesa: número negativo representando o preço
  Em caso de renda: número positivo

Usando a visão geral do fluxo de caixa efetivamente

A visão geral do fluxo de caixa é uma ferramenta poderosa para verificar se há despesas não contabilizadas.

Você deve:

• Defina a quantia atual de dinheiro que você possui para cada método de pagamento (dinheiro, cartão, ...). Você pode fazer isso usando o botão "Set" .
• Sempre que você executa uma transação, o saldo será atualizado automaticamente.
• Você pode recontar novamente seu dinheiro e ver se ele corresponde ao valor calculado. Se isso acontecer, você pode usar o botão da caixa de seleção para marcar isso. Caso contrário, você cometeu um erro ou perdeu dinheiro.

Sobre este projeto

Este projeto foi criado e mantido por mim (Jens) no meu tempo livre para minha família, e eu o fiz de código aberto na esperança de que possa ser útil para os outros.

Se você decidir usar isso, é provável que você o use muito ou pare de usá -lo depois de algum tempo. Se você estiver na categoria anterior, envie -me uma mensagem em [email protected] (ou considere enviar uma doação) para que eu saiba que os outros estão usando isso. Definitivamente, informe -me se você tiver algum interesse em atualizar para versões mais recentes ou usar os recursos mais avançados (ocultos), como taxas de câmbio e correção de inflação.