Updates to Installation Guide - Common Issues Getting Started

[aimeewirick]

Description

My Motivation I currently work for my county's finance department and I see the value this project could have for so many people/businesses. I am taking a course on open source software as part of Oregon State University's computer science program, and was excited about the possibility to be part of contributing to this project as part of my coursework.

Solved Issue While walking through the installation process I encountered several bumps that I hope to help others walk through by adding to the installation and debugging documentation.

1. The additions I made to the installation.md file:

   • I added instructions for installing the backend on a POSIX system (under the ‘Setting up the backend (Django), since I was using a POSIX system and felt that other users may benefit from documentation on how to set up in this format.

   • I added a new header ‘Problem Solving Errors’ and a link to the existing ‘debugging’ folder so that installers could quickly find the debugging section if they were having trouble with their install. Previously, installers would need to find this folder on their own and linking it directly to the instructions might save time.

   • I added a link to the existing poetry.md debugging file under the poetry installation section to give quick access if something went wrong during the poetry installation process.

2. The additions I made to the poetry.md file:

   • Not all my issues with poetry were solved with the existing problem-solving directions, so I added the header ‘For other poetry issues, or if this doesn’t fix the issue try the following:’ and included instructions for problem solving poetry installation issues that I found helpful with the import error I was having with poetry.

   • I added a link to the official website for the poetry installation, because their directions helped me solve the issue I was having, and may help with other poetry issues.

3. The additional file I created named problem-solving.md My motivation for creating this file was to add documentation addressing some of the diverse errors that a user could encounter while installing MyFinances. I added the following guides to help other users through errors I encountered.

   • I added instructions for installing middleware that would resolve the ImportError: cannot import name 'login_not_required' from 'login_required that I encountered while installing MyFinances.

   • I added instructions for installing forex_python to resolve the No module named 'forex_python' error that I encountered

   • I added instructions for four extensions for mypy_boto3 to cover several boto3 "extension name here" not found errors.

Checklist

• [x ] Ran the Black Formatter and djLint-er on any new code (checks will fail without)
• [x ] Made any changes or additions to the documentation where required
• [ x] Changes generate no new warnings/errors
• [x ] New and existing unit tests pass locally with my changes

What type of PR is this?

• 📝 Documentation Update

Added/updated tests?

• 🙅 no, because they aren't needed

Related PRs, Issues etc

• Related Issue #404
• Closes #404

[TreyWW]

Hey @aimeewirick!

First of all; amazing PR! I really appreciate the changes related to setting up, it's often a part I forget to improve.

Since you work in finance at the moment you already have much more topic related experience towards a tool like this, if you have any ideas or features I haven't even thought of feel free to bring them up! I'd be happy to work closely with you in the future.

Apologies for the late response!