How to run the app locally:
- Make sure Git and Python 3 are installed on your computer.
- Open a console in the directory where you want to download the project's source code.
- Run the following commands:
git clone https://github.com/CuQuants/app
cd app
pip3 install -r requirements.txt
- Host the app using the following command:
streamlit run frontend.py
How to use the app's query parameters:
http://localhost:8501/?page=projects
http://localhost:8501/?symbols=SPY,AAPL,GE
- Load one or more analysis steps:
http://localhost:8501/?symbols=SPY,AAPL,MSFT,GE,TSLA&steps=pca
http://localhost:8501/?topic=securities
How to update to the latest version:
- Make sure you haven't made any changes to the source code.
- Otherwise, run
git reset --hard HEAD (warning: reverts local file changes).
- Run the following commands in the
app directory:
git pull
pip3 install -r requirements.txt
How to publish your changes:
- Sign up for a GitHub account.
- Create a Fork of the CuQuants/app repository.
- Follow the How to run the project locally instructions, replacing
CUQuants with your GitHub username.
- Edit the code to your liking
- After making changes to the codebase, run the following command:
- Make sure that no files were accidentally changed.
- Afterwards, run the following commands:
- You will receive a prompt (usually a text document). Enter a one-line explanation of your changes and then close the file.
- To push the changes to your personal GitHub fork, run the following command:
- Navigate to your online GitHub repository.
- Create a pull request with a reasonably detailed explanation of your changes.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent