Skip to content

Commit f9448fd

Browse files
authored
Merge pull request #134 from Ganeshmoorthii/update-readme
Update README with New Badges and Improved Documentation Issue no #127
2 parents 60ae3e1 + a10f347 commit f9448fd

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

+34-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,31 @@
1-
2-
# Investra Paper Trading Platform
1+
# <p>Investra Paper Trading Platform
2+
<img src="https://readme-typing-svg.herokuapp.com?color=45ffaa&size=40&width=900&height=80&lines=Welcome-to-Investra-Paper-Trading-Platform"/>
3+
</p>
34

45
Investra is a user-friendly **paper trading platform** designed for individuals who want to practice stock market analysis with **fake money**, while utilizing **real-time stock prices**. It provides a risk-free environment to learn and develop trading skills.
56

6-
---
7+
<table align="center">
8+
<thead align="center">
9+
<tr border: 2px;>
10+
<td><b>🌟 Stars</b></td>
11+
<td><b>🍴 Forks</b></td>
12+
<td><b>🐛 Issues</b></td>
13+
<td><b>🔔 Open PRs</b></td>
14+
<td><b>🔕 Close PRs</b></td>
15+
</tr>
16+
</thead>
17+
<tbody>
18+
<tr>
19+
<td><img alt="Stars" src="https://img.shields.io/github/stars/SanchitGeez/Investra?style=flat&logo=github"/></td>
20+
<td><img alt="Forks" src="https://img.shields.io/github/forks/SanchitGeez/Investra?style=flat&logo=github"/></td>
21+
<td><img alt="Issues" src="https://img.shields.io/github/issues/SanchitGeez/Investra?style=flat&logo=github"/></td>
22+
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/SanchitGeez/Investra?style=flat&logo=github"/></td>
23+
<td><img alt="Closed Pull Requests" src="https://img.shields.io/github/issues-pr-closed/SanchitGeez/Investra?style=flat&color=critical&logo=github"/></td>
24+
</tr>
25+
</tbody>
26+
</table>
27+
28+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
729

830
## Table of Contents
931

@@ -21,6 +43,7 @@ Investra is a user-friendly **paper trading platform** designed for individuals
2143
- [License](#license)
2244
- [Demo](#demo)
2345

46+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
2447

2548
## Features
2649

@@ -30,7 +53,7 @@ Investra is a user-friendly **paper trading platform** designed for individuals
3053
- [ ] **Purchase and Sell Stocks**: Buy and sell stocks based on real-time data.
3154
- [x] **Responsive Design**: Optimized for use across all devices (desktop, tablet, and mobile).
3255

33-
---
56+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
3457

3558
## Tech Stack
3659

@@ -55,7 +78,7 @@ Investra is built with the following technologies:
5578
- **Axios**: For making API calls and handling HTTP requests.
5679
- **Nodemon**: Automatically restarts the server during development.
5780

58-
---
81+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
5982

6083
## Installation
6184

@@ -119,7 +142,7 @@ http://localhost:3000
119142

120143
By default, the MongoDB instance will be accessible on port `27017`, and the backend server will connect to it automatically.
121144

122-
---
145+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
123146

124147
## Usage
125148

@@ -129,7 +152,7 @@ Once the platform is running, you can:
129152
- **Buy** and **sell stocks** with real-time data using fake money.
130153
- View your **balance**, **holdings**, and **transaction history** on the dashboard.
131154

132-
---
155+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
133156

134157
## Contributing
135158

@@ -171,13 +194,13 @@ Submit a detailed pull request (PR) with a description of your changes and link
171194
- Write clear and concise commit messages.
172195
- Thoroughly test your changes before submitting a PR.
173196

174-
---
197+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
175198

176199
## License
177200

178201
This project is licensed under the **MIT License**. See the [LICENSE](./LICENSE) file for more details.
179202

180-
---
203+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
181204

182205
## Demo
183206

@@ -191,7 +214,8 @@ Here are some previews of the platform in action:
191214

192215
![Purchase Demo](https://github.com/SanchitGeez/Investra/blob/main/client/public/buy.gif)
193216

194-
---
217+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
218+
195219
## Our Top Contributors
196220

197221
- We extend our heartfelt gratitude for your invaluable contribution to our project!

0 commit comments

Comments
 (0)