Skip to content

Commit

Permalink
Merge pull request #52 from bhagatabhijeet/abhi
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
jeffreyehogg authored Aug 25, 2020
2 parents da4ef2d + 4e2b92a commit 09f7fdb
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 3 deletions.
67 changes: 64 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,70 @@
# tkrsearch

# tkrSearch

tkrSearch pronounced as "Ticker Search" is stock and cryptocurrency search application.
trkSearch searches the ticker and presents the user with company profile and useful information like current price, 52 Week High and Lows etc.

<div align="center">
<img src="images/logo_large.png"/>
</div>
<hr/>

![Project](https://img.shields.io/badge/tkrSearch-%E2%9D%A4%EF%B8%8F-blue)
[![GitHub license](https://img.shields.io/github/license/bhagatabhijeet/tkrsearch?style=plastic)](https://github.com/bhagatabhijeet/tkrsearch/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/bhagatabhijeet/tkrsearch?style=plastic)](https://github.com/bhagatabhijeet/tkrsearch/issues)
[![GitHub stars](https://img.shields.io/github/stars/bhagatabhijeet/tkrsearch?style=plastic)](https://github.com/bhagatabhijeet/tkrsearch/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/bhagatabhijeet/tkrsearch)](https://github.com/bhagatabhijeet/tkrsearch/network)


## Application, Repo and Project dashboard Urls
* Application Url : https://bhagatabhijeet.github.io/tkrsearch/index.html
* GitHub Repo : https://github.com/bhagatabhijeet/tkrsearch
* Project Kanban Board : https://github.com/users/bhagatabhijeet/projects/1
* Wiki : https://github.com/bhagatabhijeet/tkrsearch/wiki

## Application Demo
<div align="center">
<img src="https://github.com/bhagatabhijeet/tkrsearch/raw/abhi/images/TKRSEARCH.gif"/>
</div>


### Meet the team
|||
| --- | --- |
|![Abhijeet Bhagat](images/Abhi.png)|https://github.com/bhagatabhijeet (Roles : Scrum master, Project maanagement and Front end developer)|
|https://github.com/bosshogg86 (Roles : Architecture and Back end developer)|![Jeff Hogg](images/jeff.png)|
|![Muhammad Kamran](images/muhammad.png)|https://github.com/mkamran67 (Roles : Architecture and Back end developer)|
|https://github.com/vharnarine (Roles : UI designer, Front end developer and lead documentation)|![Varune Harnarine](images/varune.png)|
<hr/>

## Libraries
| Library # | Doc Link | What is it | Source |
| --- | --- | --- | --- |
| Mdbootstrap 4.19.1 | [https://mdbootstrap.com/?utm\_ref\_id=96808](https://mdbootstrap.com/?utm_ref_id=96808) | CSS framework for UI | CDN |
| jQuery | [https://code.jquery.com/](https://code.jquery.com/) | It&#39;s a JavaScript Selector and animation lib | Local File |
| moment.js | [https://momentjs.com/](https://momentjs.com/) | Time manipulation lib. Eases the date time handling | Local file |
| Tabulator | [http://tabulator.info/docs/4.7/jquery](http://tabulator.info/docs/4.7/jquery) | Tabulator allows you to create interactive tables in seconds from any HTML Table, JavaScript Array, AJAX data source or JSON formatted data. | CDN |


## API Courtesy
* https://min-api.cryptocompare.com
* https://cloud.iexapis.com


# Future Plans:
* make last 10 search persistent
* Add Graphs
* more UI features like get historical data and graphs.

# License and Code of Conduct
[License](LICENSE.md)
[Code of Conduct](CODE_OF_CONDUCT.md)

# Contributing Guidelines
[Contributing](CONTRIBUTING.md)







Application Url : https://bhagatabhijeet.github.io/tkrsearch/index.html
Binary file added images/Abhi.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/TKRSEARCH.gif
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/github.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/jeff.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/logo_large.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/muhammad.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/varune.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 09f7fdb

Please sign in to comment.