diff --git a/README.md b/README.md index 8701add..f7cf2ad 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,11 @@ kubectl apply -f k8s/app/frontend.yaml ``` +## Contribution + +Have better suggestions to optimize the image? Found some typos? Go ahead and send in a Pull Request! Contributions of any kind welcome! + + ## License The code in this repository has been released under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html) diff --git a/TODO.org b/TODO.org index c019d3c..56af80b 100644 --- a/TODO.org +++ b/TODO.org @@ -1,14 +1,13 @@ -* ToDo [0/4] +* ToDo [1/4] -- [-] Meta [1/5] - - [ ] README - - [ ] Expand acronym for bullish - - [ ] Prettify README - - [ ] License - - [ ] Usage - - [ ] Contributing - - [ ] Attributions +- [-] Meta [2/5] + - [X] README + - [X] Prettify README + - [X] License + - [X] Usage + - [X] Contributing + - [X] Attributions - [X] LICENSE - [ ] CONTRIBUTING - [ ] Link to ARCHITECTURE @@ -22,9 +21,9 @@ - [ ] TODO - [ ] Clear all tasks -- [-] Backend Django [2/4] +- [-] Backend Django [1/5] - [X] Base setup for DJango + Vue - - [X] Async (RQ mostly) job to download the equity [[https://www.bseindia.com/markets/MarketInfo/BhavCopy.aspx][bhavcopy zip]] every day at 6 PM for the current date + - [-] Async (RQ mostly) job to download the equity [[https://www.bseindia.com/markets/MarketInfo/BhavCopy.aspx][bhavcopy zip]] every day at 6 PM for the current date - [X] Verify [[https://www.bseindia.com/download/BhavCopy/Equity/EQ050221_CSV.ZIP][this link]] doesn't change per day (check web archive) - this changes everyday, the zip file is of the format "EQ`DDMMYY`_CSV.ZIP" - [X] RQ job to which starts at 6 pm @@ -33,8 +32,11 @@ - [X] if fails at 6 pm starts again after 5 mins + potential code for alert - [X] Writes the records into Redis into appropriate data structures (Fields: code, name, open, high, low, close) - [X] 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 - [X] 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 @@ -43,21 +45,23 @@ - [ ] 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 [1/6] - - [ ] Landing Page - - [ ] Prettify Bhav Copy Page +- [-] Frontend Vue [4/7] + - [X] Landing Page + - [X] Prettify Bhav Copy Page - [X] 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 - [X] Search field to search on name - [X] Button to download searched results as CSV + - [X] 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 [0/4] - - [ ] Docker - - [ ] Dockerfile - - [ ] docker-compose.yml - - [ ] Productionize K8s - - [ ] Make Architecture diagram - - [ ] [bullish.codingcoffee.me](https://bullish.codingcoffee.me) +- [X] Deploy [4/4] + - [X] Docker + - [X] Dockerfile + - [X] docker-compose.yml + - [X] Productionize K8s + - [X] Make Architecture diagram + - [X] [bullish.codingcoffee.me](https://bullish.codingcoffee.me)