loading...

Jelly Fin: Looking For Contributors

sublimegeek profile image Jonathan Irvin 惻1 min read

Jelly Fin is opensource now. Thanks to @ben for the encouragement! You can find it here:

GitHub logo jelly-fin / jelly-fin

A simple way to manage your finances with forecasting. We should automate our money, not make it automate us.

Jelly Fin

Discord Dependabot Status PRs Welcome contributions welcome


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

Installing and Running

  1. Clone the repo.
  2. Run npm install to cover any dependencies.

Common Issues:

If installation isn't working for you, check the following:

  1. 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!

Discussion

pic
Editor guide
Collapse
khaled_garbaya profile image
Khaled Garbaya

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

Collapse
migueloop profile image
Miguel Ruiz

Totally agree. Adding a wiki could be also useful. Some screenshots too.

Collapse
sublimegeek profile image
Jonathan Irvin Author

Wiki added. What kind of pages do you think I should have?

Thread Thread
migueloop profile image
Miguel Ruiz

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.

Collapse
sublimegeek profile image
Jonathan Irvin Author

Thank you! I've been looking for feedback on where to start. What is my README missing?

Collapse
khaled_garbaya profile image
Khaled Garbaya

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 :

  • Core Features (this to answer the question, is this project for me? is it gonna solve my problems?)
  • Pre-requisites && Installation (how to install/run the project)
  • Getting started (small runnable snippet of code if applicable)
  • Troubleshooting (common problems and how to fix them)
  • Get involved ( few nice words to encourage people and link to CONTRIBUTION.md)
  • LICENSE
  • CODE OF CONDUCT (really important to protect you and people)

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

Collapse
ben profile image
Ben Halpern

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.

Collapse
misterhtmlcss profile image
Roger K.

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.

Collapse
sublimegeek profile image
Jonathan Irvin Author

That's awesome. No worries about Gitter. Email works.

Collapse
pandaa880 profile image
Prashant Chaudhari

Well, nice idea. I will take a look at the repo and see if i can contribte.

Collapse
sublimegeek profile image
Jonathan Irvin Author

I'll take all the help I can get.