Stock Portfolio Tracker

A portfolio tracking web application.
Visit Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contact

About The Project

A simple web application that allows users to create an account, build their stock portfolio, and get live, to the second price update on some of the biggest stocks on the market. This was built as an learning experience, thus it uses the free tier of the Alpaca markets API, and is limited to 30 stocks at the moment.

(back to top)

Built With

• Python
• Flask
• Bulma
• PostgreSQL
• Docker
• Gunicorn
• NGINX

(back to top)

Getting Started

Prerequisites

The development environment is containerized using Docker, and the setup is relatively simple.

First you'll need to install Docker and Docker-Compose

• Ubuntu

  apt-get install docker docker-compose

• Arch Linux

  pacman -S docker docker-compose

• Other - https://www.docker.com/

You will also need NPM

• Ubuntu

  apt-get install npm

• Arch Linux

  pacman -S npm

• Other - https://www.npmjs.com/

Installation

1. Get a free API Key at https://alpaca.markets/
2. Clone the repo

   git clone https://github.com/felixlevert/stock-tracker-app.git

3. Install NPM packages in the static folder

   cd services/web/src/static
   npm install

4. Create a .env.dev file in project root with the following values

    APP_SETTINGS=DevelopmentConfig
    DATABASE_URL=postgresql://stocks_dev:stocks_dev@db:5432/stocks_dev
    FLASK_APP=src/__init__.py
    FLASK_DEBUG=1
    SECRET_KEY=**ENTER A SECRET KEY HERE**
    ALPACA_API_KEY_ID=**ENTER YOUR ALPACA API KEY HERE**
    ALPACA_SECRET_KEY=**ENTER YOUR ALPACA SECRET KEY HERE**
    SQL_HOST=db
    SQL_PORT=5432
    DATABASE=postgres
    APP_FOLDER=/usr/src/app
   

5. Build and run the docker containers

   docker-compose -f docker-compose.yml up -d --build

(back to top)

Roadmap

• Add total values for each column of the portfolio table.
• Implement a detailed statistic page that shows various graphs of performance over time.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Felix Levert - felix.levert@gmail.com

Project Link: https://github.com/felixlevert/stock-tracker-app

(back to top)