Medium to React

Medium to React is an npm package designed to simplify the integration of Medium articles into your React applications. This package allows you to fetch Medium article data by providing a username, enabling you to showcase your Medium articles directly on your website.

Installation

You can install Medium to React via npm:

npm install medium-to-react

Usage

To use Medium to React in your React application, follow these steps:

1. Import the useProfile hook from Medium to React:

import { useProfile } from 'medium-to-react';

2. Utilize the useProfile hook in your component by providing a Medium username:

const {
  profile,
  loading,
  error
} = useProfile('username');

3. Handle the states provided by the hook:

   • loading: Indicates whether the data is still being fetched.
   • error: Provides any error that may occur during the fetching process.
   • profile: Contains the JSON response of the Medium articles associated with the provided username.

4. Create your own components using the profile data. The profile object contains information about the Medium user's profile and an array of articles.

// Example of profile response structure
const profileResponse = {
  "status": "ok",
  "feed": { ... },
  "items": [ ... ]
};

// Example of accessing articles from profile response
const articles = profileResponse.items;

Example Profile Response

{
  "status": "ok",
  "feed": { ... },
  "items": [
    {
      "title": "...",
      "pubDate": "...",
      "link": "...",
      "guid": "...",
      "author": "...",
      "thumbnail": "...",
      "description": "...",
      "content": "...",
      "enclosure": {},
      "categories": [ ... ]
    },
    {
      "title": "...",
      "pubDate": "...",
      "link": "...",
      "guid": "...",
      "author": "...",
      "thumbnail": "...",
      "description": "...",
      "content": "...",
      "enclosure": {},
      "categories": [ ... ]
    }
  ]
}

Why I Created This Package

When I was creating my portfolio website, I encountered the challenge of seamlessly integrating my Medium articles. I wanted a solution that would allow me to display my latest Medium stories directly on my website without the hassle of manual updates. Medium to React was born out of this necessity. With this package, I aimed to provide a simple yet effective tool for developers to effortlessly incorporate their Medium content into their React projects.

Roadmap

In the next version, we plan to provide React components for easier integration into React applications.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer: This package is not affiliated with Medium or its parent company.