StockTracker

This page is the offical documentation for downloading and running the code in this code base.

Update:

This project is no longer in develoment. Attempting to build this project will fail because the required API keys are not present in this repo and the MongoDB servers are no longer active. See No_Server_Stockify to run the app. This project has been made public so others may learn from it's existence.

Preview:

Programming Conventions

1. All code must use tabs over spaces
2. One tab is equal to four spaces
3. All lines of code must be 80 chars or else. The only exception to this rule is for layout array that are fed to the Window constructor
4. Use camal case

Notes about the READMEs

It is very important that you read all README.md files before attempting a system test, or a unit test of certain systems here is a list of all README files:

1. /main/README.md (the one your reading)
2. /main/Helper/helper.py/README.md (used for fixing bugs in imported package)
3. /main/UnitTest/Login/README.md (used for unit testing)
4. /main/UnitTest/Helper/README.md (used for unit testing)
5. /main/Robinhoon_API/README.md (used for find robin_stocks docs)
6. /main/UnitTest/Database/README.md (used for fixing SSL cert error and set connectionString)

Setup Authorize.Net

1. Create an Authrize.Net accout at: developer.authorize.net
2. Save the API key and the transaction key
3. Login to your account
4. Go to account settings
5. Under Security Settings > General Security Settings > click Test Mode
6. Set account to Test

How to Download and Setup

1. Download Python v3.11.1
2. Run git clone https://github.com/key6oardWarrior/StockTracker
3. cd [dir that cloned StockTrader]
4. python setup.py This will install all the need python dependencies. If you have any more issue read the other README.md files

***NOTE***: MongoDB MUST be installed to do System test and any test that will use server side code

MongoDB Windows Install

1. Download here

MongoDB Linux Install

1. Run sudo dpkg -i mongodb-org-server_6.0.4_amd64.deb

Install macOS Install

1. Download link. Ensure that you are downloading Mongo DB Compas
2. Determin if your macOS is running on either ARM or Intel processor
3. Click on the downloaded .tgz file, that is for your processor, in the StockTrader folder and follow the install instructions

Run MongoDB

***NOTE***: MongoDB MUST be run to do System test and any test that will use server side code

Windows

1. Click on the MongoDBCompass app
2. Click the big green "Connect" button. The server should start running

Linux

1. Run sudo systemctl start mongod.service This will start running Mongo DB
2. To ensure that the service is running run: sudo systemctl status mongod.service

macOS

1. Click on the MongoDBCompass app
2. Click the big green "Connect" button. The server should start running

Compile All Code

Run: py compile.py

When preforming any kind of test be sure to test both the .py and .pyc files. They both must pass before you can submit a PR. Please note that while running compile.py you may encounter an error that states, "Can't list [directory]." Please ignore this error message.

Running the App

After completing all the steps in this README and the other READMEs you can run this code. Go into the app directory and in the subdirectory UI click on Stockify.pyw. This will run the entire application for the user's perspective.