Skip to content

SnehaghoshBarsha444/TinyVerse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 

Repository files navigation

TinyVerse

TinyVerse is a URL shortening service designed for seamless integration with your custom web browser, LakshyOrbit. It provides efficient and user-friendly solutions for creating short, shareable links.


Getting Started

Follow these steps to set up and run the TinyVerse project on your local machine:

Prerequisites

Ensure you have the following installed:

  • Node.js (v16 or higher) - Download here
  • npm or yarn (comes with Node.js)

Installation

  1. Clone the repository:

    git clone https://github.com/SnehaghoshBarsha444/tinyverse.git
    cd tinyverse
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Run the development server:

    npm run dev
    # or
    yarn dev
  4. Open your browser and navigate to:

    http://localhost:3000

    Explore the functionality and start shortening your URLs!


Project Structure

  • pages/: Contains application routes and components.
  • pages/api/: API routes for handling backend logic.
  • public/: Static assets such as images or icons.
  • styles/: Global and component-specific CSS.

Features

  • Fast and reliable URL shortening.
  • Customizable links for branding.
  • Seamless integration with the LakshyOrbit browser.
  • Real-time updates while editing pages.

API Endpoints

  • GET /api/hello: Sample API route to demonstrate server functionality.

Customize and extend these endpoints in the pages/api/ directory.


Deployment

TinyVerse is optimized for deployment on Vercel. To deploy:

  1. Push your repository to GitHub or another Git provider.
  2. Import your project into Vercel (Vercel Deployment Guide).

Contributing

Contributions are welcome! If you want to report issues or suggest features, please:

  • Open an issue on GitHub.
  • Submit a pull request with improvements.

📬 Contact Information

For inquiries or collaboration opportunities, connect via:


License

This project is licensed under the MIT License.


Happy coding with SnehaghoshBarsha444(Technical_Isopod_075)

About

TinyVerse: Shrinking the digital universe, one link at a time for LakshyOrbit.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published