Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added suggestions.improvement.txt with suggestions #550

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Added suggestions.improvement.txt with suggestions #550

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions suggestions.improvement.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
07-02-2025

In the Installation manual, While I was Installing the project using pycharm on
Windows 10, and using the terminal, following the instructions, I typed in
1. Create a virtual environment and activate it

python -m venv ./venv/ --> that worked

I then followed instructions and typed in
./venv/Scripts/activate

I struggled for a while but when I accidentally used the \ rather than a / and walla,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah usually windows that prefers backslash, we could add an alternative installation step for windows

everything worked fine in that I installed the directories and files as expected.

It may be an idea to update the installation manual -> 07-02-2025
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it is up to date, its just it doesnt cover every OS separately at the moment. Pretty sure it doesnt work on macos even with docker

Also the installation manual does not have a date on it
Suggestions:
==============
2. A requirements.txt doc for simplicity
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah thats not a bad idea, we could have an alternative to poetry for ease of installation. I know poetry is the cause of most installation issues and the worst to debug

3. Platform/Operating system not listed anywhere
4. main.py??? --> what and where is the entry point of the program
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use Django, they don't use a "main" file. https://www.djangoproject.com/start/

5. External libraries - I seem to have found the requirements.txt - Please update me
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a requirements.txt

6. I have spotted some dll's and no date on this project. How long has this project
been around and would you like some help refactoring and make project more accessible?

I still don't know how to start up project. And I have been through every single folder in project, read
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

View the documentation, listed on the readme

README.md, security.md, pyproject.toml ???.