Skip to content
harshtyagi334Public

About

APIVERSE is an interactive API documentation platform built with React, Vite, TypeScript, and Firebase. It helps developers explore, test, and manage APIs easily with features like an integrated playground, authentication, and a modern UI for seamless collaboration.

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

APIVERSE 🚀

APIVERSE is a modern and interactive API documentation platform designed to help developers explore, test, and manage APIs efficiently. Built with React, TypeScript, Vite, and Firebase, the platform provides a clean developer experience with a fast and responsive interface.


🌟 Overview

APIVERSE simplifies the process of understanding and testing APIs by providing:

  • Interactive API playground
  • Real-time request & response testing
  • Authentication support
  • Developer-friendly UI
  • Fast and scalable architecture

The goal of APIVERSE is to create a seamless environment where developers can experiment with APIs without relying on external tools.


✨ Features

🔹 Interactive API Playground

Test API endpoints directly from the platform with real-time responses.

🔹 Authentication System

Secure login and authentication support using Firebase Authentication.

🔹 Modern UI/UX

Clean and responsive interface built for better developer productivity.

🔹 Fast Performance

Powered by Vite for lightning-fast development and optimized builds.

🔹 Scalable Architecture

Organized code structure using React and TypeScript for maintainability.

🔹 Firebase Integration

Backend services including authentication and hosting support.


🛠️ Tech Stack

Technology Purpose
React Frontend UI
TypeScript Type Safety
Vite Fast Build Tool
Firebase Authentication & Hosting
CSS / Tailwind Styling

📂 Project Structure

APIVERSE/
│
├── public/             # Static assets
├── src/                # Source code
│   ├── components/     # Reusable UI components
│   ├── pages/          # Application pages
│   ├── services/       # API & Firebase services
│   ├── hooks/          # Custom React hooks
│   └── utils/          # Utility functions
│
├── package.json
├── vite.config.ts
└── README.md

⚙️ Installation & Setup

Prerequisites

Make sure you have installed:

  • Node.js
  • npm or yarn

Check versions:

node -v
npm -v

🚀 Run Locally

1️⃣ Clone the Repository

git clone https://github.com/harshtyagi334/APIVERSE.git

2️⃣ Navigate to Project Folder

cd APIVERSE

3️⃣ Install Dependencies

npm install

4️⃣ Start Development Server

npm run dev

The application will start on:

http://localhost:5173

🔐 Environment Variables

Create a .env file in the root directory and add your Firebase configuration:

VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id

📸 Future Improvements

  • API collection management
  • Team collaboration features
  • API analytics dashboard
  • Swagger/OpenAPI integration
  • AI-powered API assistant
  • Dark/Light theme toggle

🤝 Contributing

Contributions are welcome.

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License.


👨‍💻 Author

Harsh Tyagi

🔗 Live Demo

https://apiverse-2622f.web.app/

📁 GitHub Repository

https://github.com/harshtyagi334/APIVERSE

⭐ Support

If you like this project, consider giving it a star on GitHub.

About

APIVERSE is an interactive API documentation platform built with React, Vite, TypeScript, and Firebase. It helps developers explore, test, and manage APIs easily with features like an integrated playground, authentication, and a modern UI for seamless collaboration.

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages