@supergrowthai/next-blog
TypeScript icon, indicating that this package has built-in type declarations

1.0.12 • Public • Published

Next-Blog


Currently supports nextjs apps router only

Elevate your Next.js project with seamless blogging functionality.

Next-Blog is designed to integrate a blogging platform into your Next.js application effortlessly, akin to the simplicity of integrating NextAuth today.

Currently, Next-Blog is a work in progress and I'm excited to invite collaborators to join me in this journey. Whether you're interested in coding, documentation, design, or testing, I welcome contributions of all kinds to make Next-Blog robust and user-friendly.

Folder Structure

Quick Start

To add Next-Blog to your project, follow these simple steps:

  1. Install Next-Blog

    First, ensure you have Next.js set up. Then, install Next-Blog by adding it to your project dependencies.

    npm i @supergrowthai/next-blog
  2. Create a new route at apps/api/sgai-blog/[...page]/route.ts

  3. Update Your Route Configuration

    In your route.ts, integrate Next-Blog as shown:

    import nextBlog from "@supergrowthai/next-blog"
    
    //To use a database use the builtin MongoDBProvider or create a new Provider and create a pr?:D
    //This provider only works locally.    
    const dbProvider = async () => new FileDBProvider(dataPath)
    const {GET, POST} = nextBlog({db: dbProvider})
    
    export { GET, POST };

Roadmap

Here are the next steps on our journey to enhance Next-Blog:

  • [x] Project initialization.
  • [x] Added a simple database adapter (JSONFile + MongoDB).
  • [x] Implement internal dashboard pages for managing posts, complete with an editor.
  • [ ] Create hooks for accessing the blog content by slug
  • [ ] Introduce configuration options for managing pages, tags, and filters.
  • [ ] Create a sample theme to kickstart your blog aesthetics.
  • [ ] And more - we're open to suggestions!

Get Involved

I'm looking for contributors to help develop features, write documentation, design user interfaces, and more. If you're passionate about making content creation accessible and straightforward for Next.js developers, I'd love to hear from you.

Join me in shaping the future of blogging in Next.js. Together, we can build something amazing.


This version aims to be more engaging, inviting, and clear in its instructions and call for collaboration.

Package Sidebar

Install

npm i @supergrowthai/next-blog

Weekly Downloads

21

Version

1.0.12

License

ISC

Unpacked Size

68.8 kB

Total Files

75

Last publish

Collaborators

  • adexp