English README Jump to Japanese Version
This is a website via which users can “buy” and “sell” stocks. You will be able to manage a portfolios of stocks. Not only will this tool allow you to check real stocks’ actual prices and portfolios’ values, it will also let you buy and sell stocks with fake money (like a stocks portofolio simulator) by querying IEX for stocks’ prices. Starting with $10,000 of fake money.
- Look fot a stock acronym and input the number of share or for how much to buy. ie: If You are interested into Netflix, look for "NFLX".
- You can chose to sell whatever you want if you own it.
- Register an account. Username and password. (It can be "Test" and "123")
- Login with your account.
- Here is the default page after login. The portofolio summary, with the initial amount of money.
- On the "Quote" page, input a stock acronym. And check it's price. Doesn't work if the acronym is wrong.
- On the "Buy" page, input a stock acronym and the number of share to buy. You can't buy more than you can afford.
- After buying, the portofolio summary is updated. Shares are added to the portofolio, and the amount of money is updated.
- On the "Sell" page, input a stock acronym and the number of share to sell. You can't sell more than you own.
- After selling, the portofolio summary is updated. Shares are removed from the portofolio, and the amount of money is updated.
-
application.py: This file contains the code for the Flask web application. It includes one route (/) that handles both POST and GET requests. When the/route is requested via GET, it renders theindex.htmltemplate. When requested via POST, the user is redirected back to/via GET. -
'helpers.py': It has an implementation of an apology page. Notice how it ultimately renders a template, apology.html. It also happens to define within itself another function, "escape", that it simply uses to replace special characters in apologies. By defining escape inside of apology, we’ve scoped the former to the latter alone; no other functions will be able (or need) to call it.
Next in the file is login_required. a function that can return another function which checks login requirements.
Thereafter is lookup, a function that, given a symbol (e.g., NFLX), returns a stock quote for a company in the form of a dict with three keys: name, whose value is a str, the name of the company; price, whose value is a float; and symbol, whose value is a str, a canonicalized (uppercase) version of a stock’s symbol, irrespective of how that symbol was capitalized when passed into lookup.
Last in the file is usd, a short function that simply formats a float as USD (e.g., 1234.56 is formatted as $1,234.56).
-
static/styles.css: This directory contains the CSS code for the web application. You can modify this file to customize the appearance of your application. -
templates/index.html: This HTML file is rendered when users visit your web application.
To set up the required dependencies, follow these steps: Be sure to change pip for pip3 if necessary.
-
Clone this repository to your local machine.
-
Create a virtual environment (optional but recommended):
Using
virtualenv(if not installed, runpip install virtualenv):virtualenv venv
Or using venv (Python 3.3+):
python -m venv venv
-
If using a virtual environment (Step 2), activate it:
- On Windows:
venv\Scripts\activate
- On macOS and Linux:
source venv/bin/activate -
Install the required packages from requirements.txt:
pip install -r requirements.txt
This will set up the necessary packages for the project.
To test the Flask application, run the following command in your terminal while in your the directory:
flask runThis will start a web server that serves the Flask application. You can then access the application by opening your web browser and navigating to http://localhost:5000.
Enjoy using this stocks simulator!
これはユーザーが株式を「購入」および「売却」できるウェブサイトです。 株式ポートフォリオを管理できます。このツールでは、実際の株価とポートフォリオの価値を確認できるだけでなく、IEXをクエリして株価を取得し、架空のお金で株式を購入および売却することもできます（株式ポートフォリオのシミュレーターのように）。 初めに 10,000 ドルの架空のお金から始めます。
- 株式の略語を探し、株式の数や購入金額を入力します。例：Netflix に興味がある場合、「NFLX」を探します。
- 所有しているものを自由に売却することができます。
- アカウントを登録します。ユーザー名とパスワード。（「Test」と「123」でも良いです）
- アカウントでログインします。
- ログイン後のデフォルトページです。ポートフォリオの概要と初期金額が表示されます。
- 「Quote」ページでは、株の略称を入力し、その価格を確認します。略称が間違っている場合は機能しません。
- 「Buy」ページでは、株の略称と購入する株式の数を入力します。購入できる金額を超えることはできません。
- 購入後、ポートフォリオの概要が更新されます。株式がポートフォリオに追加され、金額が更新されます。
- 「Sell」ページでは、株の略称と売却する株式の数を入力します。所有している株式より多くを売ることはできません。
- 売却後、ポートフォリオの概要が更新されます。株式がポートフォリオから削除され、金額が更新されます。
-
application.py: このファイルには Flask ウェブアプリケーションのコードが含まれています。このアプリケーションには POST リクエストと GET リクエストの両方を処理する 1 つのルート（/）が含まれています。/ルートは GET でリクエストされるとindex.htmlテンプレートがレンダリングされます。POST でリクエストされた場合、ユーザーは GET を介して再度/にリダイレクトされます。 -
'helpers.py'：これは謝罪ページの実装を持っています。注意してください、最終的にはテンプレートである 'apology.html' をレンダリングしています。また、それ自体内部に別の関数 "escape" を定義しており、謝罪文の中の特殊文字を単純に置換するために使用しています。"escape" を謝罪の中で定義することで、前者を後者にスコープ化しました。他の関数はそれを呼び出すことはできず（または必要ありません）。
次に、ファイル内に [login_required] があります。この関数はログイン要件をチェックする別の関数を返すことができます。
その後には lookup があります。この関数はシンボル（例：NFLX）を指定すると、企業の株価を含む辞書形式で返します。辞書には name（会社名を表す文字列）、price（株価を表す浮動小数点数）、symbol（株式のシンボルの正規化された大文字形式を表す文字列）の 3 つのキーがあります。lookup に渡されたシンボルの大文字化に関係なく、シンボルは正規化されます。
ファイル内の最後には usd があり、これは浮動小数点数を単純に USD としてフォーマットする短い関数です（例：1234.56 は $1,234.56 としてフォーマットされます）。
-
static/styles.css: このディレクトリにはウェブアプリケーションの CSS コードが含まれています。このファイルをカスタマイズしてアプリケーションの外観を変更できます。 -
templates/index.html: この HTML ファイルはユーザーがウェブアプリケーションを訪れたときにレンダリングされます。
必要な依存関係を設定するには、次の手順に従ってください：
必要に応じてpipをpip3に変更してください。
-
このリポジトリをローカルマシンにクローンしてください。
-
仮想環境を作成します（オプションですが推奨）：
virtualenvを使用する場合（インストールされていない場合はpip install virtualenvを実行）：virtualenv venv
または venv を使用する場合（Python 3.3+）：
python -m venv venv
-
仮想環境を使用する場合（ステップ 2）、それをアクティブにします：
- Windows の場合：
venv\Scripts\activate
- macOS および Linux の場合：
source venv/bin/activate -
requirements.txt から必要なパッケージをインストールします：
pip install -r requirements.txt
これでプロジェクトの必要なパッケージが設定されます。
Flask アプリケーションをテストするには、ディレクトリ内で次のコマンドを実行してください：
flask runこれにより、Flask アプリケーションを提供するウェブサーバーが起動します。その後、ウェブブラウザを開いて http://localhost:5000 にアクセスすることで、アプリケーションにアクセスできます。
この株式シミュレーターをお楽しみください！