live-stock

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 18 Open GitHub ↗

Stock trading website - final project for databases class

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# LiveStock

LiveStock is a rudimentary stock trading website built as the course project for CSE 305: Principles of Database Systems taken at Stony Brook University in Spring 2016. This project was built by our team of three people. Below are some of the project specifications, given on our professor's [website](http://www3.cs.stonybrook.edu/~sas/courses/cse305/spr16/project/main.html).

The repository is organized into the following relevant components: the website and all associated assets are in the __LiveStockSite__ folder; the sql files necessary to populate the database are in the __sql__ folder; and the __assignments__ folder contains all write-ups, including the final user guide.

- - -

## 1 System Users

The users of your system will be the customers that use your system to trade stocks and pay fees for doing so, customer representatives who provide customer-related services, and the site's manager. You should assume that the computer knowledge of the users is limited (say, that of a typical AOL subscriber), and thus your system must be easy to access and operate. Customers of a stock-trading system are sometimes also known as clients, so I shall use these two terms interchangeably.

## 2 Required Data

The data items required for the stock-trading database can be classified into four categories: orders, stocks, customers and employees, where an order is an order to buy or sell a certain number of shares of a particular stock at a certain price.

This classification does not imply any particular table arrangement. You are responsible for arranging the data items into tables, determining the relationships among tables and identifying the key attributes. In addition, you should include indices in your tables to speed up query processing. You should base your choice of indices on the type and expected frequency of the queries outlined in Section 3. Finally, you should specify and enforce integrity constraints on the data, including referential integrity constraints.

As I mentioned in class, you will first create an E-R diagram of your online trading system before developing your relational model. Details of this assignment will soon become available on blackoard.

### 2.1 Order Data

This category of data should include the following items:
* Order ID
* Stock Symbol(GM, GE, IBM, etc.)
* Order Type (Buy, Sell)
* Number of Shares
* Customer Account Number (of the buyer or seller)
* Date/Time (the order was placed)
* Transaction Fee
* Price Type (Market, Market on Close, Trailing Stop, Hidden Stop)
* Employee ID

An order is the mechanism a customer uses to buy or sell a certain number of shares of a particular stock at a certain price. A transaction fee of 5% is associated with every order.

Your online trading system will also support Conditional Orders such as a Trailing Stop or Hidden Stop order. A Trailing-Stop order uses a trailing stop to automatically decide when to place a sell order. A trailing stop is set at a percentage or dollar amount below the stock's current market price, and a sell order will be placed if and when the share price falls to the trailing stop. The trailing stop is adjusted as the share price fluctuates.

In contrast, a Hidden-Stop order uses a fixed hidden-stop price to automatically decide when to place a sell order. That is, a sell order will be placed if and when the stock price falls to the hidden stop.

To understand conditional orders better, suppose that you have just bought 1000 shares of GM at $50.00, and you decide that you only want to risk $5.00 per share on this transaction. Accordingly, you immediately place a hidden-stop order at $45.00. This means that if the price of GM should drop to $45.00, your broker will sell your 1000 shares at a market price of $45.00. The use of a hidden-stop order will therefore pre-determine the maximum loss a trader will incur.

Instead of placing a hidden-stop order on your GM shares, suppose now that you place a trailing-stop order with a trailing-stop value of $5.00 (or, equivalently, a trailing-stop percentage of 10%). Thus, your shares will be sold if the share price drops to $45.00. But instead of declining, the price of GM increases to $60.00; but so does the trailing stop. So now your shares will be sold if the share price drops to $55.00. Thus the trailing-stop technique allows an investor to set a limit on the maximum possible loss without setting a limit on the maximum possible gain, and without requiring paying attention to the investment on an ongoing basis.

To find out more about how conditional orders work, please consult the E*TRADE Conditional Orders Tutorial.

### 2.2 Stock Data

This category of data should include the following items:
* Stock Symbol
* Stock Name
* Stock Type
* Share Price
* Number of Shares

An order involves the purchase or sale of a certain number of shares of a stock at a certain price. Stocks are of a certain type: GM is an automotive stock, IBM is a computer stock, etc. You can populate your database with any kind of stocks you like. We will provide you with all the stock data you need to demo your system to us at the end of the semester.

### 2.3 Customer Data

The items required for this category include:
* Last Name
* First Name
* Address
* City
* State
* Zip Code
* Telephone
* E-mail Address
* Account Number
* Account Creation Date
* Credit Card Number
* Stock Portfolio
* Rating

A given customer may partake in any number of stock transaction, either as a buyer or as a seller. A customer may have one or more accounts from which to trade stocks. Associated with each account is a stock portfolio, indicating which stocks (and number of shares) are held in that account. The customer's rating should reflect how active a trader he or she is.

### 2.4 Employee Data

This category of data should include the following:
* Social Security #
* Last Name
* First Name
* Address
* City
* State
* Zip Code
* Telephone
* Start Date
* Hourly Rate

## 3 User-Level Transactions

A database transaction can be viewed as a small program (written in the DML) that either updates or queries the database. Transactions that change the contents of the database must do so in a consistent manner. Moreover, transactions should not interfere with one another when running concurrently.

What follows is a breakdown of the user-level transactions that your database system should support. To make sure transactions maintain the integrity of the database, you must write them using the SQL transaction structuring capabilities (i.e., begin transaction, commit transaction, etc.).

### 3.1 Manager-Level Transactions

The manager should be able to:
* Set the share price of a stock (for simulating market fluctuations in a stock's share price)
* Add, Edit and Delete information for an employee
* Obtain a sales report for a particular month
* Produce a comprehensive listing of all stocks
* Produce a list of orders by stock symbol or by customer name
* Produce a summary listing of revenue generated by a particular stock, stock type, or customer
* Determine which customer representative generated most total revenue
* Determine which customer generated most total revenue
* Produce a list of most actively traded stocks

### 3.2 Customer-Representative-Level Transactions

Customer Representatives should be thought of as stock brokers and should be able to:
* Record an order
* Add, Edit and Delete information for a customer
* Produce customer mailing lists
* Produce a list of stock suggestions for a given customer (based on that customer's past orders)

### 3.3 Customer-Level Transactions

Customers should be thought of as online traders and should be able to easily browse your online trading system on the web and place orders to purchase or sell stocks. In particular, they should be able to place a trailing-stop or hidden-stop conditional order, and place an order to buy or sell stocks at market or close-of-market price. While they will not be permitted to access the database directly, they should be able to retrieve the following information:
* A customer's current stock holdings
* The share-price and trailing-stop history for a given conditional order
* The share-price and hidden-stop history for a given conditional order
* The share-price history of a given stock over a certain period of time (e.g., past six months)
* A history of all current and past orders a customer has placed
* Stocks available of a particular type and most-recent order info
* Stocks available with a particular keyword or set of keywords in the stock name, and most-recent order info
* Best-Seller list of stocks
* Personalized stock suggestion list

## 4 User Access Control

Your database system should provide controlled access to the data by distinguishing between the different types of users: manager, customer representatives, and customers.

Customer Representatives should not be able to perform manager-level transactions; however, they should be able to read employee information, except for the hourly rate.
Customer Representatives should be able to record the receipt of an order from a customer.
A customer should not be allowed access to other customers' account information, or to any employee information. Also, trailing and hidden stops must be kept private.

## 5 Utilities

In addition to the transactions described above, the system should provide facilities for:
* Allowing the manager to add and delete users
* Backing up the database files
* A comprehensive Help facility, including a topic-driven pull-down Help menu

## 6 User Interface

HTML and its successors provide facilities for creating pop-up and pull-down menus, value lists, input/output forms, labels and customized reports. You should make use of all of these capabilities, and in the process come up with a system that caters to users with only limited computer knowledge. The information you provide to customers should look professional and inviting.

## 7 Documentation

You will be required to supplement your completed database implementation with a design document that contains information concerning your design criteria and decisions. The following is a list of some of the information you should include:
* Entity-Relationship (E-R) Diagram of the complete database scheme
* Lucid description of the relational database scheme for yoru online stock trading system, including a discussion of the reasoning behind your design decisions. Make clear how your design supports efficient query processing.
* A list of all functional dependencies in the relational database scheme
* Description of integrity constraints including referential integrity

You will also be required to submit a Users Guide that carefully explains how to use all aspects of the system. It should be understandable by non-computer experts. Be sure that the user interface (screen design, menu structure, etc.) is clearly explained.

live-stock

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README