Skip to content

Commit 70123ee

Browse files
Hrishikesh-DalalHrishikesh-Dalal
authored
Revise README with new project details and APIs
Updated project name, description, and added detailed API references and roadmap.
1 parent 0351b5f commit 70123ee

File tree

1 file changed

+106
-61
lines changed

1 file changed

+106
-61
lines changed

‎README.md‎

Lines changed: 106 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,112 @@
1-
# React Verse – Free API Dashboard (Hacktoberfest)
2-
3-
An all-in-one React (Vite) dashboard showcasing multiple free, no-auth public APIs. Built as a friendly Hacktoberfest playground for first-time and seasoned contributors alike.
4-
5-
## Dashboards Implemented
6-
- Weather (wttr.in)
7-
- Cryptocurrency (CoinGecko)
8-
- Space & Astronomy (Open Notify – ISS + Astronauts)
9-
- Movies (Studio Ghibli API)
10-
- Recipes (TheMealDB)
11-
- Trivia Quiz (Open Trivia DB)
12-
- Jokes & Quotes (Official Joke API + Quotable)
13-
- Dog / Cat Images (Dog CEO + Cataas)
14-
- COVID-19 Tracker (covid19api.com)
15-
16-
## Quick Start
1+
# 🌐 ReactVerse – The Open API Playground
2+
3+
**ReactVerse** is an open-source API dashboard built with **React + Vite**, designed to help developers explore, visualize, and learn how to integrate public APIs safely and responsibly.
4+
It’s more than just a project — it’s a **community-driven learning space** for understanding how APIs work, managing data securely, and contributing meaningfully to open source.
5+
6+
Perfect for **Hacktoberfest**, **beginners**, and **API enthusiasts** who want to get hands-on experience using real-world APIs.
7+
8+
---
9+
10+
## 🚀 What’s Inside
11+
12+
A collection of interactive dashboards that fetch and display data from **free, no-auth public APIs** — all in one unified, open-source interface.
13+
14+
| Dashboard | API Used | Description |
15+
| --------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
16+
| ☀️ Weather | [wttr.in](https://wttr.in/:help) | Get real-time weather updates and forecasts |
17+
| 💰 Cryptocurrency | [CoinGecko](https://www.coingecko.com/en/api) | Track live crypto prices and market data |
18+
| 🛰️ Space & Astronomy | [Open Notify](http://open-notify.org/Open-Notify-API/) | View ISS location and current astronauts in orbit |
19+
| 🎬 Movies | [Studio Ghibli API](https://ghibliapi.vercel.app/) | Explore Studio Ghibli’s magical movie catalog |
20+
| 🍳 Recipes | [TheMealDB](https://www.themealdb.com/api.php) | Find meal ideas and cooking inspiration |
21+
| 🎯 Trivia Quiz | [Open Trivia DB](https://opentdb.com/api_config.php) | Challenge yourself with fun trivia questions |
22+
| 😂 Jokes & Quotes | [Joke API](https://official-joke-api.appspot.com/) + [Quotable](https://github.com/lukePeavey/quotable) | Daily dose of humor and motivation |
23+
| 🐶🐱 Pets | [Dog CEO](https://dog.ceo/dog-api/) + [Cataas](https://cataas.com/#/) | Random cute dog and cat images |
24+
| 🦠 COVID-19 Tracker | [COVID19 API](https://covid19api.com/) | Track pandemic stats and trends globally |
25+
26+
---
27+
28+
## 🧠 Why ReactVerse?
29+
30+
* 🧩 **Learn by doing** — See how public APIs work and how to safely handle data fetching.
31+
* 🔐 **Promote API safety** — No API keys, no secrets, just best practices for secure integration.
32+
* 🌍 **Open to everyone** — Ideal for contributors learning React, APIs, or GitHub workflows.
33+
* 💬 **Collaborative & inclusive** — A space where you can build, break, and improve together.
34+
35+
---
36+
37+
## ⚙️ Quick Start
38+
1739
```bash
1840
npm install
1941
npm run dev
2042
```
21-
Open http://localhost:5173
22-
23-
## Tech Stack
24-
- React 18 + Vite
25-
- React Router v6
26-
- Fetch API (no extra client)
27-
- Simple CSS (custom light/dark theme)
28-
29-
## Contributing (Hacktoberfest)
30-
See `CONTRIBUTING.md` for detailed instructions, ideas, and open enhancement areas. Beginner-friendly issues will be labeled.
31-
32-
## Roadmap / TODO Highlights
33-
- Enhance UI polish, accessibility, and animations
34-
- Add search, filters, and favorites persistence per dashboard
35-
- Add charts (price trends, COVID daily trends, weather graphs)
36-
- Replace placeholder chart component with a real library
37-
- Add service worker + offline caching for selected data
38-
- Add testing (Vitest + React Testing Library)
39-
- Add type safety (TypeScript migration) – optional future step
40-
41-
## API References
42-
| Area | API | Docs |
43-
| ---- | --- | ---- |
44-
| Weather | wttr.in | https://wttr.in/:help |
45-
| Crypto | CoinGecko | https://www.coingecko.com/en/api |
46-
| Space | Open Notify | http://open-notify.org/Open-Notify-API/ |
47-
| Movies | Studio Ghibli | https://ghibliapi.vercel.app/ |
48-
| Recipes | TheMealDB | https://www.themealdb.com/api.php |
49-
| Trivia | Open Trivia DB | https://opentdb.com/api_config.php |
50-
| Jokes | Official Joke API | https://official-joke-api.appspot.com/ |
51-
| Quotes | Quotable | https://github.com/lukePeavey/quotable |
52-
| Pets | Dog CEO / Cataas | https://dog.ceo/dog-api/ / https://cataas.com/#/ |
53-
| COVID-19 | COVID19 API | https://covid19api.com/ |
54-
55-
## License
56-
MIT – see `LICENSE`.
57-
58-
## Acknowledgements
59-
Community-driven project for educational purposes. External API data © respective providers.
60-
61-
## Credits
62-
63-
Hrishikesh Dalal (https://www.hrishikeshdalal.tech/)
64-
65-
Venisha Kalola (https://www.venishakalola.tech/)
6643

44+
Then open [http://localhost:5173](http://localhost:5173) in your browser.
45+
46+
---
47+
48+
## 🧰 Tech Stack
49+
50+
* ⚛️ React 18 + Vite
51+
* 🧭 React Router v6
52+
* 🌐 Fetch API (no external client)
53+
* 🎨 Custom Light/Dark CSS Theme
54+
55+
---
56+
57+
## 🤝 Contributing
58+
59+
We welcome contributions of all levels — from design tweaks to feature enhancements!
60+
61+
* Check out `CONTRIBUTING.md` for setup instructions and issue labels.
62+
* Look for **`good first issue`** or **`help wanted`** tags to get started.
63+
* Participate in **Hacktoberfest** and grow your open-source journey with us.
64+
65+
---
66+
67+
## 🗺️ Roadmap
68+
69+
* ✨ Improve UI/UX and accessibility
70+
* 🔍 Add search, filters, and persistent favorites
71+
* 📊 Integrate charts (e.g. weather graphs, price trends)
72+
* 🧱 Introduce a real charting library (e.g. Recharts or Chart.js)
73+
* ⚙️ Add offline caching with service workers
74+
* 🧪 Include testing (Vitest + React Testing Library)
75+
* 🧾 Optional: Migrate to TypeScript for type safety
76+
77+
---
78+
79+
## 📚 API Reference
80+
81+
| Category | API | Documentation |
82+
| -------- | ----------------- | ----------------------------------------------------------------------------------------------------- |
83+
| Weather | wttr.in | [https://wttr.in/:help](https://wttr.in/:help) |
84+
| Crypto | CoinGecko | [https://www.coingecko.com/en/api](https://www.coingecko.com/en/api) |
85+
| Space | Open Notify | [http://open-notify.org/Open-Notify-API/](http://open-notify.org/Open-Notify-API/) |
86+
| Movies | Studio Ghibli | [https://ghibliapi.vercel.app/](https://ghibliapi.vercel.app/) |
87+
| Recipes | TheMealDB | [https://www.themealdb.com/api.php](https://www.themealdb.com/api.php) |
88+
| Trivia | Open Trivia DB | [https://opentdb.com/api_config.php](https://opentdb.com/api_config.php) |
89+
| Jokes | Official Joke API | [https://official-joke-api.appspot.com/](https://official-joke-api.appspot.com/) |
90+
| Quotes | Quotable | [https://github.com/lukePeavey/quotable](https://github.com/lukePeavey/quotable) |
91+
| Pets | Dog CEO / Cataas | [https://dog.ceo/dog-api/](https://dog.ceo/dog-api/) / [https://cataas.com/#/](https://cataas.com/#/) |
92+
| COVID-19 | COVID19 API | [https://covid19api.com/](https://covid19api.com/) |
93+
94+
---
95+
96+
## 🪪 License
97+
98+
MIT – see `LICENSE` for full details.
99+
100+
---
101+
102+
## 💡 Acknowledgements
103+
104+
This project is community-built for **educational and open-source learning** purposes.
105+
106+
---
107+
108+
## 👥 Credits
109+
110+
* [Hrishikesh Dalal](https://www.hrishikeshdalal.tech/)
111+
* [Venisha Kalola](https://www.venishakalola.tech/)
67112

0 commit comments

Comments
 (0)