Wampamba David
Wampamba

Wampamba

Do you want to contribute to a small Open source project as Developer?

An Open Source Tool which helps you generate Unlimited Invoices for FREE.

Wampamba David
·May 28, 2022·

4 min read

Play this article

Table of contents

  • What can the Distributa app do for you?
  • Which Technologies did I use?
  • Why should you bother to Contribute?
  • How to use the Distributa App?
  • Steps to follow.
  • Where can we improve?
  • What could we add?
  • How to Contribute?

Check out a small project I made recently to help users generate Unlimited PDF Invoices for FREE. Click here to see demo

What can the Distributa app do for you?

  1. Help you determine what people share from a given Amount.
  2. Help you generate Unlimited PDF invoices for FREE.

Which Technologies did I use?

The Technologies are popular and backed by large communities. They offer a good developer experience, they're free and easy to learn.

  1. ReactJS
  2. Bootstrap CSS
  3. React PDF library
  4. Vercel .com hosting
  5. Git for Version Control
  6. Github for collaboration and code hosting

Why should you bother to Contribute?

  1. It motivates me and other contributors.
  2. Take the opportunity to create the impact doing what you love.
  3. Gain experience.
  4. Increase your Github commits.
  5. Increase your chances of landing a job as a Developer.
  6. It helps to learn from you.
  7. Add your voice to Open Source.
  8. Receive credit through mentions.
  9. Use the code to build your own SaaS project.

How to use the Distributa App?

Let me start by informing you that Distributa is a web app. Being a Web App you need a device that has a Web Browser like Google Chrome, Firefox and others to use it. You also need an active internet connection.

Steps to follow.

Determine Distribution

  1. Visit distributa.vercel.app
  2. Enter Amount to be shared.
  3. Click the Enter button or Press Enter key on the keyboard.
  4. You will be take to the page where you can add any number of Beneficiaries.
  5. On the left of the beneficiary page type the name of beneficiary and the percentage allocated to the beneficiary followed by clicking the Add button or press the Enter Key on the keyboard.
  6. The Distributa app will automatically calculate and display the summary at the right of the beneficiary page. The summary will show Amount being shared, Distributed Amount and percentage, number of beneficiaries, remaining amount and percentage. At the bottom of the summary is the Reset button in yellow to help you restart the process quickly.

Generate Invoice

  1. Visit distributa.vercel.app
  2. You'll see a top bar in a dark shade and three (3) items. The 3 items are the App name "Distributa" and two links which are Share and Invoice.
  3. Click Invoice which will load the Invoice page.
  4. On the Invoice page enter all the necessary details.
  5. Click Download PDF.
  6. A PDF file will be downloaded on your computer.
  7. You can also click save and the invoice will be stored on your computer in local storage

Where can we improve?

  1. UI/UX for Mobile/Web
  2. TDD ( Test cases and Test averages)
  3. Error handling
  4. Open Source License

What could we add?

I think for this Open Source project to offer the much needed value we could polish it by adding the following features.

  1. Currency switch for the Distributa feature.
  2. Send Invoice via Email
  3. Generate Invoice URL
  4. Save Invoice in Cloud & Users device
  5. Save Distribution
  6. History Access

How to Contribute?

A good place to start is the demo and the GitHub link https://github.com/davidofug/distributa.git

By visiting the demo you get first hand experience with the app and when you access the Github link you will access the code and be able to see how it was developed. If you like what you see or want to improve it then you can contribute.

Code and Technical contributions

  1. Fork to get your copy.
  2. Clone Fork to your computer.
  3. Navigate to the project directory and:-
    • Run yarn add or npm install
    • Run yarn start or npm start
  4. Test your code and make sure it works.
  5. Commit and use a concise commit message.
  6. Push to your repo.
  7. Send a PR.
  8. Wait for PR review.
  9. Your contribution will go live in a few days after approval.
  10. If not approved you will get response.

Other contributions

  1. You can contribute by using the app and sharing your feedback via the Github issues tab
  2. You can suggest features
 
Share this