https://github.com/hanahem/popfolio

🍭 A light off-chain crypto portfolio tracker
https://github.com/hanahem/popfolio

cryptocurrency dashboard

Last synced: 25 days ago
JSON representation

🍭 A light off-chain crypto portfolio tracker

• Host: GitHub
• URL: https://github.com/hanahem/popfolio
• Owner: hanahem
• Created: 2021-05-23T10:49:09.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2022-01-28T11:17:38.000Z (almost 3 years ago)
• Last Synced: 2024-10-08T03:21:14.131Z (3 months ago)
• Topics: cryptocurrency, dashboard
• Language: TypeScript
• Homepage:
• Size: 4.2 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


  

 



Popfolio.    




[![Status](https://img.shields.io/badge/status-active-success.svg)]()

[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/hanahem/popfolio/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/hanahem/popfolio/pulls)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)



---

 A light off-chain crypto portfolio tracker

    
 



## 📝 Table of Contents

- [About](#about)

- [Getting Started](#getting_started)

- [Deployment](#deployment)

- [Usage](#usage)

- [Built Using](#built_using)

- [TODO](./TODO.md)

- [Contributing](./CONTRIBUTING.md)

- [Authors](#authors)

- [Acknowledgments](#acknowledgement)

## 🧐 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](#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](https://www.vercel.com/).

## ⛏️ Built Using 

- [Next with Typescript](https://www.nextjs.org/) - React Framework

- [TailwindCSS](https://tailwindcss.com/) - CSS Framework

- [Dexie](https://dexie.org/) - IndexedDb Wrapper

- [Redux](https://redux.js.org/) - React State Container

## ✍️ Authors 

- [@hanahem](https://github.com/hanahem) - Idea & Initial work

See also the list of [contributors](https://github.com/hanahem/popfolio/graphs/contributors) who participated in this project.

## 🎉 Acknowledgements 

- [@TBouder](https://github.com/TBouder) for some ideas and inspiration

- Inspiration: Uniswap, Zapper.fi, Zerion

- References: [This Dribble Design](https://cdn.dribbble.com/users/2716253/screenshots/15516075/media/611362828179bf2bfffe5ab7485c54c4.png?compress=1&resize=1600x1200) and [this one](https://cdn.dribbble.com/users/2716253/screenshots/15516075/media/611362828179bf2bfffe5ab7485c54c4.png?compress=1&resize=1600x1200)