Skip to content

Commit

Permalink
💯 Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
pishangujeniya committed Nov 10, 2022
1 parent b50bdb2 commit 6d56990
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 34 deletions.
72 changes: 39 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,62 @@
# Kite Helper - Download Stock Market Data
<p align="center">
<img src="./src/KiteHelper/ClientApp/src/assets/images/icon.png" width="100px" height="100px">
</p>
<br>

## 🌎 [Website](https://pishangujeniya.github.io/kite-helper/docs)
<h1 align="center">Kite Helper - Download Stock Market Data</h1>

![Website](https://img.shields.io/website?url=https%3A%2F%2Fpishangujeniya.github.io%2Fkite-helper%2F)
![GitHub issues](https://img.shields.io/github/issues/pishangujeniya/kite-helper)
![GitHub closed issues](https://img.shields.io/github/issues-closed/pishangujeniya/kite-helper)
![GitHub last commit](https://img.shields.io/github/last-commit/pishangujeniya/kite-helper)
![GitHub license](https://img.shields.io/github/license/pishangujeniya/kite-helper)
<p align="center">
<strong>Indian Stock Market in CSV</strong>
</p>

[![Docker](https://img.shields.io/badge/Docker-pishangujeniya%2Fkite--helper-blue)](https://hub.docker.com/r/pishangujeniya/kite-helper)
[![GitHub issues](https://img.shields.io/github/issues/pishangujeniya/kite-helper)](https://github.com/pishangujeniya/kite-helper/issues?q=is%3Aopen+is%3Aissue)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/pishangujeniya/kite-helper)](https://github.com/pishangujeniya/kite-helper/issues?q=is%3Aissue+is%3Aclosed)
[![GitHub last commit](https://img.shields.io/github/last-commit/pishangujeniya/kite-helper)](https://github.com/pishangujeniya/kite-helper/commits/main)
[![commit activity](https://img.shields.io/github/commit-activity/y/pishangujeniya/kite-helper.svg)](https://github.com/pishangujeniya/kite-helper/commits/main)
[![GitHub license](https://img.shields.io/github/license/pishangujeniya/kite-helper)](https://github.com/pishangujeniya/kite-helper/blob/main/LICENSE)

Simple Application to Download any stock market data in `.csv` format using Kite

![Kite Helper](./images/pexels-anna-nekrashevich-6801648.jpg)
![Kite Helper Login Screen](./images/pexels-anna-nekrashevich-6801648.jpg)

## 🏃‍♂️ Running Server
Simple Web Application to download Indian stock market data in `.csv` format using Kite

- [Download ZIP from Releases and Extract](https://github.com/pishangujeniya/kite-helper/releases)
- Install dependencies `pip install -r ./requirements.txt` (to generate requirements.txt file from project run `pipreqs ./ --force`)
- Run `python main.py`
- Open Site [https://pishangujeniya.github.io/kite-helper/docs](https://pishangujeniya.github.io/kite-helper/docs)
- Add your configuration URL mentioned in running Server
- Login to Kite
- Select Trading Symbol and Date Range and press **Get Data**
## 😍 Features

- **simple & easy** Run the docker image, that's it.
- **purely local** Everything is in `your control`.
- **privacy:** we don't know your credentials, its everything in your environment 🙈.
- **no ads** strictly no `advertisements & spams`
- **open source** source code is visible to all. Nothing is hidden.
- **clean:** no `extra` bullshit!

## ⚠ Warning
> The project or the creator is in any ways not reponsibile for any of your actions. Do at your own risk.
## 📷 Screenshots

> For education purpose only.
![Kite Helper Login Screen](./images/kite-helper-login-screen.png)

> We do not collect any data or information.
![Kite Helper Historical Data Screen](./images/historical-data-list-screen.png)

> We do not have any connection to the user who is using this script.
![Kite Helper Historical Data Download Screen](./images/historical-data-download-screen.png)

> The code of project is totally opensource and is very simple and easy to understand which can confirm the above statements.
## 💻 Getting Started

## 💪 Project created & Maintained by

[Pishang Ujeniya](https://github.com/pishangujeniya)

> If you are happy to use this project and found this project helpful for you as well as others or you learned something from the source code of this project and want to thank me,
```
docker run -p 8080:80 -d pishangujeniya/kite-helper
```

## ⚠️ Warning
- The project or the creator is in any ways not reponsibile for any of your actions. Do at your own risk.
- For education purpose only.
- We do not collect any data or information.
- We do not have any connection to the user who is using this.
- The code of project is totally opensource and is very simple and easy to understand which can confirm the above statements.
- If you are happy to use this project and found this project helpful for you as well as others or you learned something from the source code of this project and want to thank me,
- Be a [Stargazer](https://github.com/pishangujeniya/kite-helper) to this repository.
- Share with your friends and colleagues.
- Follow and Endorse me on [linkedin](https://www.linkedin.com/in/pishangujeniya).

## 💰 Donations
*Star it!* If it worked for you.
- *Star it!*
- [PayPal](https://paypal.me/Pishang)

### 😍 Donors
1. Your Name could be here - [Donate Now](https://paypal.me/Pishang)


<a href="https://paypal.me/Pishang"><img src="./images/9218.jpg"></a>
Binary file added images/historical-data-download-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/historical-data-list-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/kite-helper-login-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/pexels-anna-nekrashevich-6801648.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/KiteHelper/ClientApp/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "kitehelper",
"version": "2.0.0",
"version": "1.0",
"scripts": {
"postinstall": "ngcc --properties es2015 es5 browser module main --first-only --create-ivy-entry-points",
"install:packages": "npm install --legacy-peer-deps --location=project",
Expand Down

0 comments on commit 6d56990

Please sign in to comment.