Coder Social home page Coder Social logo

chnapy / picsou-dashboard Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 1.0 3.67 MB

A dashboard to see all your financial investments on one place, for mobile & desktop.

Home Page: https://picsou-dashboard.web.app

License: MIT License

Shell 0.13% JavaScript 6.29% HTML 0.82% TypeScript 92.77%
financial dashboard firebase

picsou-dashboard's Introduction

Picsou logo

Picsou dashboard

A dashboard to see all your financial investments on one place, for mobile & desktop.

  • Handle these kind of value:
    • ๐Ÿฆ cash (banks)
    • ๐Ÿ“ˆ market (stock actions)
    • ๐ŸŒ  gold (Bullion Vault)
  • Show values evolution in time: gains & losses
  • See estimation of total of your investments
  • ๐Ÿ’น Check values histories with charts
  • Add and edit values at any time
  • ๐Ÿ”’ Security & confidentiality: check below
  • ๐Ÿ“ฑ Mobile first, but also for desktop
  • PWA compliant, you can install this app then use it like a mobile app, or desktop one
  • Preview mode with fake data, to show the concept to your best friends
  • Used by Balthazar Picsou himself

โš ๏ธ This is a read-only app. You cannot buy/sell stock actions, gold, or manipulate your bank account: you're seeing changes, not doing them.

Mobile screenshot Mobile screenshot for chart

๐Ÿ”’ Security & confidentiality

This app shows and store sensitive personal data. To avoid any security risk some choices were made:

  • On-Premise - Backend part is handled by Firebase (Google secure serverless solution), with strict access rules. You have to use your Firebase account, so all your data stay in your hands. You just have to be ok with Google confidentiality policy.

  • Whitelist-based - App access rules allow only users you specified (it can be only you).

You can see database rules here. They allow database access only on auth users that are in the whitelist.

Some external services are used to get fresh data (current stock price, gold price, etc). More infos below.

Setup

// TODO explain:

  • fork
  • firebase setup
  • config variables/files/secrets
  • security concerns (rules, whitelist)

๐Ÿ“œ External API & services used

Market: investing.com (unofficial API)

Data that can be send:

  • ID representing stock action
  • Search term (from edit dialog)

Gold: bullionvault.com (unofficial API)

Data that can be send: none.

Cash: linxo.com (scraping)

This one is quite specific. There is no common free API to fetch all banks data, so a bank account aggregator is used instead: Linxo. This service does not provide a free API, so its website is scraped every day to get all accounts infos.

Note that using this feature requires a Linxo account, and to put credentials in the app (in secret).

Data that can be send:

  • Linxo credentials (used only for authentication)

๐Ÿง I have questions

Don't be shy, fill an issue !

picsou-dashboard's People

Contributors

chnapy avatar

Watchers

 avatar  avatar

Forkers

tomvsmith

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.