Lex-Opt - Intro & Overview

Documentation index

A. Introduction and overview

B. Programming & Implementation Guide

C. Directory Structure

D. Development & System Scheme

Phase 1.

Phase 2.

E. Suggestions for Further Improvement

A. Introduction

This document describes the purposes of the project and provides an outline for the development & implementation.

The lex-opt web application will assist in investment management and options trading as a tool to: - manage with buying and selling equities, - and to trade options in our portfolios.

Lex-opt will initially be used only personally but may eventually be used by others.

The application is designed to be scalable, extensible, and responsive.

B. Implemention Guidelines

• Development and testing will use a browser and through the localhost environment and the existing Apache2 local server.

• Debugging will involve executing lex-opt.html file on a browser (initially Firefox Developer).

• After development and testing, files will be uploaded to the domain LEX-OPT.com.

• GIT will not be used.

• Automated testing will not be used (at present) - perhaps later

• Version control will be manually implemented by making copies of functioning project implementation phases.

• Minifying of CSS/JS files will not be done until development phases are complete and testing finished.

• Security will be limited to verifying data and will only be required during phase 2. ___

Programming Principles

1. No external libraries will be used.
2. Plain vanilla JavaScript will be used for functions client-side.
3. PHP will be used for data access.
4. Styling will use SCSS and CSS.
5. Data will be stored in .JSON files in the JSONcache directory.
6. the term “select” will refer to:
   • on the desktop version - either a single click of the lft button on a mouse or the “enter” key on a keyboard that will activate the selected function, e.g., choose a value from a menu
   • on the small & touch screen versions, select will be a single tap of the finger ___

C. Directory Structure

This is a general structure to be used on all directories.

The main directory is /var/www/html/lex-opt_4.0 and contains the following subdirectories:

1. CSS:
   • Contains SCSS files for styling.
   • Partial SCSS files are prefixed with _ (e.g., _kern.scss).
   • The main.scss file imports all partials.
2. documentation:
   • Contains text files for creating pages:
     • displayPage.text
     • auxiliary.text
     • equityPage.text
3. Errors:
   • errors will be document in text format and stored in the Errors directory
   • files will be name with the date and the extension .txt
4. examples:
   • Contains HTML files for testing functionalities independently.
5. JS:
   • Contains all JavaScript files.
6. JSONcache:
   • Stores JSON data files:
     • Latest uploads (e.g., nuData.json).
     • Archived data (e.g., APPL.json).
     • Analytical data (e.g., 200-day moving averages).
7. PHP:
   • Contains PHP files for data access.
8. textFiles: ___

D. Development Procedure

The development of the lex-opt project is ambitious and divided into 2 phases. Currently, only instructions for Phase 1 have been attempted.

• Phase 1.
  • create the user interface and user interactions
  • create the forms & functions for: 1 accessing external data through PHP functions
    2. implement the storage stategy for assets
    3. provide functions to access assets
• Phase 2.
  • analyze the historical data and experiences to improve the management and employment of equities and options.

Phase 1 - development

The implementation of this phase consists of building three distinct parts: - the displayPage - a table displaying the equities from the local achive - the equityPage - pages constructed dynamically from data in the local archive - the functions to access external data and to create the local archive

1. displayPage

• Purpose:

  The landing page of the web app.

• Description

  This page will give an overview of chosen equitie - a tabular display of specific information from external sources for chosen NASDAQ & NYSE equities.

• Features:

  • Dynamically constructed table with rows for each equity.
  • Each row contains brief, current, and summary information of one equity.
  • Includes current open or watchlisted options information.
  • a row will contain a button that opens the specific page for this equity

• File Name:

  • file to be produced is to be named: displayPage.html

• Implementation instructions

  • use instructions in file documentation/md/script_displayPage.text.

2. equityPage

• Purpose: A dynamically constructed dashboard for individual equities.

• Description

  • Individual Equity Pages: A dynamically constructed page for an equity presented in the displayPage table
    • the page will be constructed and presented upon selecting a button on the row descibing that equity.
    • Information includes ticker symbol, equity name, historical data (that will be accessed from the data stored in the Archives directory).
    • Option information will be stored historically - this will be used in Phase 2 to discover patterns.
    • Data to be displayed will be stored in .JSON files (e.g., APPL.json).

• Features:

  • Built and activated by selecting an equity row in displayPage.
  • Includes notes, analysis, and historical/current option information.

• Implementation instructions

  • use instructions in file documentation/md/script_equityPage.text.

• File Name: equityPage.html

3. Auxiliary Fcts

• Purpose:

  • Forms, Fucntions for data access & archiving.
  • Accessible from both displayPage and equityPage.

• Features:

  • Forms for adding/deleting entries from the table in displayPage.
  • Data stored in JSONcache and archived after submission.

• Implementation instructions

  • use instructions in file documentation/md/script_auxiliary.text.

• File Names:

  • JS functions stored in /JS/auxiliaryFcts.js.
  • PPH functions stored in /PHP/auxiliary.php

E. Suggestions for Further Improvement