Skip to content

Commit a05d8a3

Browse files
authored
Update README.md
1 parent c5010fb commit a05d8a3

File tree

1 file changed

+46
-15
lines changed

1 file changed

+46
-15
lines changed

README.md

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010
[![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
1111
[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org/)
1212
[![Finnhub](https://img.shields.io/badge/Finnhub-1B1B1B?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNmZmZmZmYiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIj48cGF0aCBkPSJNMyA2aDJsMTUgMk0xNyA2djE0TTcgMTZoMTAiLz48L3N2Zz4=)](https://finnhub.io/)
13+
[![API Docs](https://img.shields.io/badge/API_Docs-000000?style=for-the-badge&logo=github&logoColor=white)](https://hackstyx.github.io/portfolio-tracker/)
1314

1415
<p align="center">
1516
<strong>A modern, responsive stock portfolio tracker built with React and Node.js</strong>
1617
</p>
1718

18-
[Live Demo](https://portfolio-tracker-hackstyx.vercel.app)[API Documentation](#-api-endpoints)[Report Bug](https://github.com/HackStyx/portfolio-tracker/issues)
19+
[Live Demo](https://portfolio-tracker-hackstyx.vercel.app)[API Documentation](https://hackstyx.github.io/portfolio-tracker/)[Report Bug](https://github.com/HackStyx/portfolio-tracker/issues)
1920

2021
> **Note**: Due to the free tier limitations of Render, the initial load of the demo might take 30-60 seconds. If no data appears, please refresh the page. If issues persist, click the logout button to reset the application state. The backend spins down after 15 minutes of inactivity and needs time to restart.
2122
@@ -84,31 +85,48 @@ npm run migrate
8485
npm start
8586
```
8687

87-
## 🔌 API Endpoints
88+
## 🔌 API Documentation
89+
90+
Our API is fully documented and available at [https://hackstyx.github.io/portfolio-tracker/](https://hackstyx.github.io/portfolio-tracker/)
8891

8992
### Base URL
9093
```
9194
https://portfolio-tracker-backend-y7ne.onrender.com/api
9295
```
9396

94-
### Portfolio
97+
### Key Endpoints
9598

96-
```
97-
GET /api/stocks # Get portfolio stocks
98-
POST /api/stocks # Add stock
99-
PUT /api/stocks/:id # Update stock
100-
DELETE /api/stocks/:id # Remove stock
99+
#### Portfolio Management
100+
```http
101+
GET /stocks # Get all stocks in portfolio
102+
POST /stocks # Add new stock
103+
PUT /stocks/:id # Update existing stock
104+
DELETE /stocks/:id # Remove stock from portfolio
101105
```
102106

103-
### Watchlist
104-
107+
#### Watchlist Management
108+
```http
109+
GET /watchlist # Get watchlist items
110+
POST /watchlist # Add stock to watchlist
111+
DELETE /watchlist/:id # Remove from watchlist
105112
```
106-
GET /api/watchlist # Get watchlist
107-
POST /api/watchlist # Add to watchlist
108-
PUT /api/watchlist/:id # Update watchlist item
109-
DELETE /api/watchlist/:id # Remove from watchlist
113+
114+
#### Market Data
115+
```http
116+
GET /stocks/:ticker/quote # Get real-time stock quote
117+
GET /stocks/:ticker/history # Get historical price data
118+
GET /stocks/summary # Get portfolio analytics
110119
```
111120

121+
For detailed API documentation including:
122+
- Request/Response formats
123+
- Authentication details
124+
- Rate limiting
125+
- Error handling
126+
- Code examples
127+
128+
Visit our [API Documentation](https://hackstyx.github.io/portfolio-tracker/)
129+
112130
## ⚡️ Tech Stack
113131

114132
### 🎨 Frontend
@@ -162,4 +180,17 @@ DELETE /api/watchlist/:id # Remove from watchlist
162180

163181
## 📄 License
164182

165-
MIT © [HackStyx](LICENSE)
183+
This project is licensed under the MIT License.
184+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
185+
186+
For more information, see the [LICENSE](LICENSE) file in the repository.
187+
188+
189+
190+
<div align="center">
191+
<p>THANK YOU FOR VISITING ❤️</p>
192+
</div>
193+
194+
<p align="center">
195+
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
196+
</p>

0 commit comments

Comments
 (0)