Giter VIP home page Giter VIP logo

medusa-plugin-blog's Introduction

medusa-plugin-blog

Provides a basic blog backend for Medusa.

Documentation

If you are not familiar with Medusa, you can learn more on the project web site.

Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.

This plugin is under development and should be considered experimental.

Breaking changes are very likely to occur.

Features

  • Posts can be tagged with products, collections, and/or custom tag values.
  • Posts can be queried by tag, category, product, or collection.

Installation

yarn add medusa-plugin-blog
medusa migrations run

Configuration

const plugins = [
  `medusa-plugin-blog`,
  ...
]

API Endpoints

GET /store/blog/posts

return jsons object containing an array of all blog post objects

GET /store/blog/posts/:handle

return json object containing a single blog post object

GET /store/blog/categories

return json object containing an array of all blog category objects

GET /store/blog/categories/:handle

return json object containing a single blog category object

GET /store/blog/categories/:handle/posts

return json object containing an array of all blog post objects for a given category

GET /store/blog/tags

return json object containing an array of all blog tag objects

GET /store/blog/tags/posts

return json object containing an array of all blog post objects for a given tag or array of tags Example: /store/blog/tags/posts?tag=tag1&tag=tag2&tag=tag3 etc

GET /store/blog/products/:id

return json object containing an array of all blog post objects for a product with given id

GET /store/blog/collections/:id

return json object containing an array of all blog post objects for a collection with given id

POST /admin/blog/categories

create a new blog category object Expects body with:

{
   handle: string!,
   title: string!,
   description: string,
   keywords: string[],
   metadata: jsonb
}

POST /admin/blog/categories/:id

update an existing blog category object with given id Expects body with:

{
   handle: string!,
   title: string!,
   description: string,
   keywords: string[],
   metadata: jsonb
}

DELETE /admin/blog/categories/:id

delete an existing blog category object with given id

POST /admin/blog/posts

create a new blog post object Expects body with:

{
   handle: string!,
   title: string!,
   author: string,
   published: boolean,
   content: string,
   description: string,
   keywords: string[],
   category_id: string,
   tag_ids: string[],
   product_ids: string[],
   collection_ids: string[],
   metadata: jsonb
}

POST /admin/blog/posts/:id

update an existing blog post object with given id Expects body with:

{
   handle: string!,
   title: string!,
   author: string,
   published: boolean,
   content: string,
   description: string,
   keywords: string[],
   category_id: string,
   tag_ids: string[],
   product_ids: string[],
   collection_ids: string[],
   metadata: jsonb
}

DELETE /admin/blog/posts/:id

delete an existing blog post object with given id

POST /admin/blog/tags

create a new blog tag object Expects body with:

{
   value: string!
}

POST /admin/blog/tags/:id

update an existing blog tag object with given id Expects body with:

{
   value: string!
}

DELETE /admin/blog/tags/:id

delete an existing blog tag object with given id

Objects

BlogPost

{
   id: string!,
   handle: string!,
   title: string!,
   author: string,
   published: string!,
   content: string,
   description: string,
   keywords: string[],
   category_id: string,
   category: Category,
   tags: BlogTag[],
   products: Product[],
   collections: Collection[],
   metadata: jsonb,
   created_at: DateTime!,
   updated_at: DateTime!
}

BlogTag

{
   id: string!,
   value: string!
}

BlogCategory

{
   id: string!,
   handle: string!,
   title: string!,
   description: string,
   keywords: string[],
   metadata: jsonb,
   posts: BlogPost[]
}

Product

Default Medusa Product object

Collection

Default Medusa Collection object

medusa-plugin-blog's People

Contributors

pevey avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

medusa-plugin-blog's Issues

Plan to build UI?

hi,I found it's only backend。I can't find admin dashborad has POST/BLOG button

Calling the GetBlogPost endpoint from the admin

I was able to add the blog post and category by adding the below code in the hooks. But I can't able to retrieve it. Since it's not under useAdminEntity. I can't do it. Any ideas?

const {
  useAdminEntity: useAdminBlogPostState,
  useAdminUpdateMutation: useAdminUpdateBlogPostStateMutation,
} = createCustomAdminHooks("blog/posts", "blog_post");

const {
  useAdminEntity: useAdminBlogCategoryState,
  useAdminUpdateMutation: useAdminUpdateBlogCategoryStateMutation,
} = createCustomAdminHooks("blogcategory", "blog_category");

Foreign key constraint violation on POST req

Update: Nah, I was wrong, First I created a category, then blog post. It's working now.

Looks like the plugin isn't performing the migration automatically. So I had to run `npx @medusajs/medusa-cli migrations run

Everything went well. But when I tried to create a new blog post. I came across a foreign key constraint violation.

 driverError: error: insert or update on table "blog_post" violates foreign key constraint "FK_543439d139e604f9553a07dfa3f"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.