codingcoffee/bullish
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: update todo and contri

Browse source 
Signed-off-by: Ameya Shenoy <shenoy.ameya@gmail.com>
This commit is contained in:
Ameya Shenoy 2021-02-12 17:28:32 +05:30
parent c4360b27c6
commit fbb2efea87
Signed by: codingcoffee
GPG key ID: F7D58AAC5DACF8D3
2 changed files with 30 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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 ## 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) 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)

46
TODO.org
View file

@ -1,14 +1,13 @@
* ToDo [0/4] * ToDo [1/4]
- [-] Meta [1/5] - [-] Meta [2/5]
- [ ] README - [X] README
- [ ] Expand acronym for bullish - [X] Prettify README
- [ ] Prettify README - [X] License
- [ ] License - [X] Usage
- [ ] Usage - [X] Contributing
- [ ] Contributing - [X] Attributions
- [ ] Attributions
- [X] LICENSE - [X] LICENSE
- [ ] CONTRIBUTING - [ ] CONTRIBUTING
- [ ] Link to ARCHITECTURE - [ ] Link to ARCHITECTURE
@ -22,9 +21,9 @@
- [ ] TODO - [ ] TODO
- [ ] Clear all tasks - [ ] Clear all tasks
- [-] Backend Django [2/4] - [-] Backend Django [1/5]
- [X] Base setup for DJango + Vue - [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) - [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" - this changes everyday, the zip file is of the format "EQ`DDMMYY`_CSV.ZIP"
- [X] RQ job to which starts at 6 pm - [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] 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] Writes the records into Redis into appropriate data structures (Fields: code, name, open, high, low, close)
- [X] make multiple endpoints - [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 - [-] Endpoint to serve main app
- [X] If cache empty load from postgres and put it into redis - [X] If cache empty load from postgres and put it into redis
- [ ] Default redis endpoint fails
- [ ] Button for Pagination - [ ] Button for Pagination
- [ ] No Pagination - [ ] No Pagination
- [ ] Pagination to return 100 entries - [ ] 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` - [ ] Allow google auth for emails ending in `zerodha.com` or `zerodha.tech` or `shenoy.ameya@gmail.com`
- [ ] JWT - [ ] JWT
- [ ] Optionally have a demo username and password for login - [ ] Optionally have a demo username and password for login
- [ ] Documentation
- [-] Frontend Vue [1/6] - [-] Frontend Vue [4/7]
- [ ] Landing Page - [X] Landing Page
- [ ] Prettify Bhav Copy 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] 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] Search field to search on name
- [X] Button to download searched results as CSV - [X] Button to download searched results as CSV
- [X] Veutify raise alert on error or success
- [ ] Handle login - [ ] Handle login
- [ ] On table bar per quantity in cell - [ ] On table bar per quantity in cell
- [ ] Red for stocks going down, green for up - [ ] Red for stocks going down, green for up
- [ ] Deploy [0/4] - [X] Deploy [4/4]
- [ ] Docker - [X] Docker
- [ ] Dockerfile - [X] Dockerfile
- [ ] docker-compose.yml - [X] docker-compose.yml
- [ ] Productionize K8s - [X] Productionize K8s
- [ ] Make Architecture diagram - [X] Make Architecture diagram
- [ ] [bullish.codingcoffee.me](https://bullish.codingcoffee.me) - [X] [bullish.codingcoffee.me](https://bullish.codingcoffee.me)