Jelly Fin is opensource now. Thanks to @ben for the encouragement! You can find it here:
two-jelly-beans
/
jelly-fin
A simple way to manage your finances with forecasting. We should automate our money, not make it automate us.
Jelly Fin
Finances are hard. It's one of the first adulting things everyone has to wrestle with. So, let's make it easy and automate it. Over the course of several years, my wife and I have tracked our finances using a forecasting method and had done it all within a spreadsheet. The time came where I wanted to take this concept and make it mobile using serverless architecture and clean design.
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
- Node v8.x.x or use NVM
- A Firebase project
Installing and Running
- Clone the repo.
- Run
npm installto cover any dependencies.
Common Issues:
If installation isn't working for you, check the following:
- Your version of node (v 8.x.x) & npm(vā¦
Right now, it's just me, but I could use some help if you're willing. I've never truly done a serious open-source project before so I'm not sure where to start to make sure it's successful. Any tips?
If you're interested in pitching in, sweet. The most I can offer is just some exposure to cool things like serverless architecture, multi-platform development, clean design, and a LOT of opinions.
I have some issues created now to outline some features, but I could use some help in documentation, building out the API on AWS, and then the beast that will be the client.
Please comment below if you're interested in what should be a fun project!
Top comments (11)
Hey Jonathan,
This looks good and I love the idea, here's my feedback:
To get people attracted to your repo I think having a good README is a good start, Let people know what is it about and how they can contribute/run and test the project locally.
Mentioned that Contribution is always welcome
Marks the easy issues as first-good-issue or help-wanted and add more details I would even point to some code where to start
Totally agree. Adding a wiki could be also useful. Some screenshots too.
Wiki added. What kind of pages do you think I should have?
I would start writing an introduction with the state of art. Why you started the project, if there is any others projects doing the same. A small diagram of the technologies that you are using/architect.
Of course in README.md at least how to start the project locally and a small explanation to new developers.
Reading what it's there didn't make me understand exactly what's all this about.
Just my opinion. I hope my feedback helps you.
Thank you! I've been looking for feedback on where to start. What is my README missing?
the First thing a README IMO is a clear sentence (TL;DR version) what is the repo about.
After that a table of content for easy navigation.
Sections can be :
for CONTRIBUTION.md you get some inspiration from famous repos, it's basically a spec document on how to run tests, add PR, code style and so on
I've been a bit too busy to get involved, and it still might be a while, but I've starred and watched the repo so I'll try to keep up.
I've also made you a moderator of the jellyfin tag
EDIT: dev.to/t/jellyfin/edit
Tag mods are a new functionality so let me know how that experience goes.
Good luck, it may take some time to gather momentum, but we'll be here to help the project progress over time.
Hi Jonathan, I'm interested. I also manage our finances and or investing too. My wife currently makes the king cash and I make sure the numbers keep progressing toward a happy ending/retirement, but the tooling I'd are is pretty terrible. I'm looking at your repo on my phone right now; might join the gitter too, but FYI if I help I may not be available on Gitter. I try keep my comms tools to a minimum.
That's awesome. No worries about Gitter. Email works.
Well, nice idea. I will take a look at the repo and see if i can contribte.
I'll take all the help I can get.