Skip to content

CodePathpod15/Stonx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

Stonx

Table of Contents

  1. Overview
  2. Product Spec
  3. Wireframes
  4. Schema

Overview

Description

Stonx is a an application to help early investors gain experience in the stock market. Our app allows every investors to simulate what it is like to invest in the stock market without actually losing any money. Along with simulating transactions, we use user feedback to create a rating system for each stock. We use this system call smart stocks to create stocks suggestions every single day (click on the lightbulb). Our app also allows users to save their favorite app and to also compare stocks with one another while looking at real time data.

App Evaluation

[Evaluation of your app across the following attributes]

  • Category: Finance + Education
  • Mobile: This app is primarly mobile but could also be expanded to desktop.
  • Story: Uses real time data to allow users to trade without actually investing money
  • Market: Anyone interesting in investing.
  • Habit: This app could be used frequently to check on the status of their app
  • Scope: We could expand to a more learning based approach to investing. Allowing users to invest in options
  • Key Features: All UI is done programmatic, no storyboard or xib files. The app also uses websockets to retrieve real time data

Installation & tips

  1. Clone the repo
git clone https://github.com/CodePathpod15/Stonx/
  1. Note that since our alphavantage API only allows us to do 5 request per minute, the app may not always return the about, sector,market cap,volume,P/E Ratio and EPS sections.

or download the app using our testflight link: https://testflight.apple.com/join/mONZP92n

Product Spec

1. User Stories (Required and Optional)

Required Must-have Stories

  • User can log in
  • user can create an account
  • reset password using email
  • User can search for stock
  • user can see the information of a stock
  • User can buy a stock
  • User Can sell a stock
  • user gets a recommened stock
  • user is able to look at the recommended sotck
  • User can set their favorite stocks
  • User can see their profit from the stock
  • User can change their profile information
  • user can delete their account
  • User can see their dashboard
  • user can see their updated stock chart
  • User can see their history of trades
  • user sees real time stock data via web sockets
  • Comparing two different stocks
  • programmatic UI
  • ...

Optional Nice-to-have Stories

  • User can change their profile (e.g. dark mode, ligth mode)
  • User can comment on a specific stock (discussion)
  • Walkthrough of the app
  • News headline
  • ask the user for the number of experiences (1 to 2 years)

2. Screen Archetypes

  • Login
    • User can log in
  • Create account
    • User can create account
  • Home (Dashboard) [list second screen here]
    • Chart of profits and losses
    • Your current porfolio
  • Favorites (Watch list)
    • Show your favorite
  • Search Stock [list second screen here]
  • View Stock
    • Shows the data from the stock (charts)
    • The option to buy and sell
    • The option bookmark the stock
    • Discussion of a stock
    • News headline
  • Settings
    • Edit profile
    • deposit
    • Reset profile (bankrupt)
    • Light mode and dark mode
    • The option to buy and sell
    • Deletre account

3. Navigation

Tab Navigation (Tab to Screen)

  • Home (dashboard)
  • Favorites
  • Search
  • Settings

Flow Navigation (Screen to Screen)

  • Favorites
    • Being able to click on each a stock
  • Seaching stock screen
    • Clicking on a stock
    • Confirm purchase of a stock
  • Home
    • Being able to click on each a stock
    • ...
  • Home
    • Edit money
    • Username
    • Image
    • email
    • Delete account

Wireframes

Screen Shot 2022-10-17 at 6 45 18 PM

[BONUS] Digital Wireframes & Mockups

https://www.figma.com/file/uEPK45BGlDkHqQEa1qiZb6/Stonx?node-id=0%3A1

[BONUS] Interactive Prototype

video2

Schema

[This section will be completed in Unit 9]

Models

user_stocks

Property Type Description
objectId String unique id for the user post (default field)
ticker_id string. ticker symbol id
ticker_symbol string symbol.
buying_price double ticker symbol id
date_purchased string the purchased date
quantity integer amount purchased

Stocks_Bookmarked

Property Type Description
objectId String unique id for the user post (default field)
ticker_id string. ticker symbol id
ticker_symbol string symbol.

stock_discussion

Property Type Description
objectId String unique id for the user post (default field)
author Pointer to User author
ticker_id Pointer to User the id of ticker symbol
ticker_symbol string ticker smbil
comment_str String caption by author
commentsCount Number number of comments that has been posted to an image
createdAt DateTime date when post is created (default field)
updatedAt DateTime date when post is last updated (default field)

Features

Comparing stocks

  • user can search for two different stocks to compare video2

Viewing Real time stock Data using alpaca markets Socket

Buying Stocks

video2

Selling Stocks

video2

Creating A watchlist

video2

video2

Smart stocks: receive recommendations based on user surveys

user survey

  • We survey users that have owned stocks every 7 days. video2

Recommendations

video2

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published