/popfolio

🍭 A light off-chain crypto portfolio tracker

Primary LanguageTypeScript

Project logo

Popfolio.

Status GitHub Issues GitHub Pull Requests License


A light off-chain crypto portfolio tracker

📝 Table of Contents

🧐 About

Popfolio is for hodlers who don't make too many trades and want to keep track of all their assets in the same browser. It's a convenient way of tracking your assets right between swiss-knife dashboards and spreadsheets.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

node
yarn
next
vercel

Installing

The development env doesn't require a lot, there are no ENVs, APIs or other dependencies.

After cloning the repo, you can install the deps

yarn

And start your dev server

yarn run dev
OR
next

End with an example of getting some data out of the system or using it for a little demo.

🎈 Usage

The app uses Redux for app state management, and Dexie.js to manage an IndexedDb instance.
IndexedDb uses your browser storage to save your assets and wallets. If you encounter problems or want to wipe your data, just clean your app's memory through the inspector.
Otherwise you can add wallets and assets to your profile and monitor them.

🚀 Deployment

You can deploy the app using Vercel.

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements