bullish/TODO.org

• ToDo [1/4]

ToDo [1/4]

• Meta [2/5]

  • README

    • Prettify README
    • License
    • Usage
    • Contributing
    • Attributions
  • LICENSE

  • CONTRIBUTING

    • Link to ARCHITECTURE

  • ARCHITECTURE

    • Where’s the thing that does X?
    • What does the thing that I am looking at do

    • Inspiration

      • kubecost architecture.md
      • git-scm architecture.md
      • rust-analyzer architecture.md

  • TODO

    • Clear all tasks

• Backend Django [1/5]

  • Base setup for DJango + Vue

  • Async (RQ mostly) job to download the equity bhavcopy zip every day at 6 PM for the current date

    • Verify this link doesn't change per day (check web archive)

      • this changes everyday, the zip file is of the format "EQ`DDMMYY`_CSV.ZIP"

    • RQ job to which starts at 6 pm

      • extracts and parses the CSV file in it
      • dump data into postgres and redis
      • if fails at 6 pm starts again after 5 mins + potential code for alert

    • Writes the records into Redis into appropriate data structures (Fields: code, name, open, high, low, close)

      • make multiple endpoints
    • Invalidate old data
    • When it has 2 days work of data in postgres only populate that with today

  • Endpoint to serve main app

    • If cache empty load from postgres and put it into redis
    • Default redis endpoint fails

    • Button for Pagination

      • No Pagination
      • Pagination to return 100 entries

  • Login

    • Open endpoint without login
    • Allow google auth for emails ending in `zerodha.com` or `zerodha.tech` or `shenoy.ameya@gmail.com`
    • JWT
    • Optionally have a demo username and password for login
  • Documentation

• Frontend Vue [5/7]

  • Landing Page
  • Prettify Bhav Copy Page

  • Renders a simple VueJS frontend with a search box that allows the stored entries to be searched by name and renders a table of results and optionally download the results as CSV. Make this page look nice

    • Search field to search on name
    • Button to download searched results as CSV
  • Veutify raise alert on error or success
  • Handle login
  • On table bar per quantity in cell
  • Red for stocks going down, green for up

• Deploy [4/4]

  • Docker

    • Dockerfile
    • docker-compose.yml
  • Productionize K8s
  • Make Architecture diagram
  • [bullish.codingcoffee.me](https://bullish.codingcoffee.me)