Code Review - Anish Gupta

[nkanish2002]

My team was supposed to a code review of another project but we couldn't find the repository of the project. So I will do a code review of this project.

Code Review

1. There are few residual files from the MacOS file system, .DS_Store namely. This file is unnecessary, you might want to remove this file and add this to .gitignore.
2. Website: It looks like you have a local copy of all the libraries (flexbox grid, font-awesome) you are using in your web pages, although republishing that code may be legal, it's not a good practice to do so. One recommendation is to use package managers like npm, bower or yarn.
3. LICENCE: I observed that there is a GPLv3 LICENCE in the archive folder copyrighted to FSF. If you are using some other repository that has a GPLv3, you should fork the repository instead of copying the files to your repository, make changes and add it to your repository as a submodule. Also, add a license to the root of your repository.
4. Python Modules: A python module is a directory containing related python files initialized with a __init__.py file . I observed that there are many stray python files, you could organize them into modules rather than standalone python scripts. If you are implementing your software in python, you need to adhere to the Python style guide. You can use code analyzers like pylint or pep8 module. While creating a python project, you need to specify which python version you are using and create a requirement file, generally named requirement.txt.
5. Python Code: The python code seems fine. There are comments in almost every file describing specific code decisions. If the code is OpenSource, the python code should have docstrings which is defined in PEP-257. Also when you comment out a part of the code, like in webUI_Networking/server.py, you should add a comment describing the reason for commenting out the code.
6. Archive: I am curious to know the utility of this directory in the code as the code here makes no sense, there are different languages being used here, PHP, Python, ASPX, Jupyter Notebooks, etc. You should add a README for this directory explaining its purpose.
7. Security: In file MongoLogin/login_register.py. I can clearly see the password to your MongoDB server, dishantp:[email protected]:57485. You should try to use a configuration file which is not public for this purpose.

[Bowenislandsong]

Thanks for the quality code review. I appreciate your suggestions and will make these corrections accordingly. I honor the code copy rights and their licenses. Thank you for pointing out the right way of using these libraries.