Skip to content

Latest commit

 

History

History
204 lines (135 loc) · 7.04 KB

README.md

File metadata and controls

204 lines (135 loc) · 7.04 KB
Raw

🏠 Homepage

strapi-medusa-template for Strapi v4

Bring the power of two awesome open source system together. It comes preloaded with the plugins that you need kick start medusa. This is a batteries included implementation so that you can get down writing your customisations

npx create-strapi-app strapi-medusa --template https://github.com/Kyle772/strapi-medusa-template.git

🚀 Getting started with Strapi

Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.

develop

Start your Strapi application with autoReload enabled. Learn more

npm run develop
# or
yarn develop

start

Start your Strapi application with autoReload disabled. Learn more

npm run start
# or
yarn start

build

Build your admin panel. Learn more

npm run build
# or
yarn build

⚙️ Deployment

Strapi gives you many possible deployment options for your project. Find the one that suits you on the deployment section of the documentation.

Docker

We've provided a dockerfile and docker compose file build file also for you reference.

Configuration

Environment Settings

These values will need to be sent in your .env file or equivalent enivorment sttings, please generate these keys as per the recommended To know more about how to create the keys please read this (https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/configurations/optional/api-tokens.html#usage)

HOST= PORT= APP_KEYS=,,,

Admin Settings

API_TOKEN_SALT= ADMIN_JWT_SECRET=

Users-Permissions Plugin Settings

JWT_SECRET=

Strapi Medusa Interface

Strapi runs as slave to medusajs. It just makes it easier when there is one boss :)

MEDUSA_STRAPI_SECRET=<MEDUSA JWT SECRET, needs to be the same as that used in medusa project config jwt_secret> SUPERUSER_USERNAME= defaults to "SuperUser", SUPERUSER_PASSWORD= defaults to "MedusaStrapi1", SUPERUSER_FIRSTNAME=<firstname, coz strapi loves addressing by firstname> defaults to "Medusa", SUPERUSER_LASTNAME= defaults to "Commerce", SUPERUSER_EMAIL=<you better have an email address or your not from this century :)> defaults to "support@medusa-commerce.com",

All the default values are there too for your refernce.

Database Settings

DATABASE_HOST= DATABASE_PORT= DATABASE_NAME= DATABASE_USERNAME= DATABASE_PASSWORD= DATABASE_SSL= DATABASE_SCHEMA=

Media Bucket

Media bucket store big chunks of data that you can't hold in the database, they can be uploaded using upload apis This version comes preinstalled with S3 support

If you are not using AWS then S3_ACCESS_KEY_ID= S3_ACCESS_SECRET_KEY= S3_BUCKET= S3_REGION=

Senty helps track any issues that your system may encounter

SENTRY_DSN= SENTRY_KEY= SENTRY_API_KEY= SENTRY_WEBHOOK_SECRET=

Search

Search is the most critical part of any content system. This comes preconfigured with melisearch

MEILISEARCH_HOST= MEILISEARCH_MASTER_KEY=

Redis Cache

This implementation qcomes preconfigured with redis caching, As medusa already uses redis, it was a reasonable assumption that the same redis service can be used for strapi as well

REDIS_HOST= REDIS_PORT= REDIS_PASSWORD=

Messaging

Sometimes you've got to just send a message, we've preconfigured this with SENDGRID

SENDGRID_API_KEY= SENDGRID_NOTIFICATION_FROM_ADDRESS=

Other Environment settings

You can read about other environment settings that strapi provides here

Routes Available

For the full list of routes currently supported by the API

use the command npx strapi routes:list

Preinstalled plugins

  1. Seo
  2. Strapi-plugin-medusajs
  3. Users-permissions
  4. Strapi-plugin-sso
  5. Upload - via s3 provider
  6. Email - via sendgrid
  7. Sentry - troubleshooting
  8. Meilisearch
  9. content-versioning (experimental), requires a patch that wasn't released at the time
  10. strapi-google-translator
  11. comments
  12. io
  13. other mandatory strapi plugins as defined in package.json

Middleware enabled

  1. redis
  2. content security policy
  3. powered by
  4. query

Known issues,

  1. Get doesn't support queries, All entities have to be retrieved by via their corresponing medusa id,
  2. Unique fields need to be set by medusa, strapi's unique fields feature has been not used.
  3. Only UID is the strapi provided id. Each strapi id, is mapped to a medusa_id if the data exists in medusa,
  4. Need to convert to typescript
  5. Service tests don't check apis that use media types, though api tests cover it all.
  6. Testing currently limited to APIs not plugins
  7. Product-option title isn't a required field. We will need to access the product option repository and determine the corresponding title. Happy to accept a PR,with tests

Show your support

I love developing software and building products that are useful. I sincerely hope you this project helps you. I'm happy to help if you need support setting this up. Give a ⭐️ if this project helped you! Catch me on discord @govdiw

As you might have guessed by now that considerable time and effort has gone into make this product useful to the community at large, and I'd love to keep maintaining and upgrading this. However, As much as we love FOSS software, nothing in this world is truly free. Please help by [sponsoring or supporting the project]. (https://github.com/sponsors/SGFGOV)

📚 Learn more

  • Resource center - Strapi resource center.
  • Strapi documentation - Official Strapi documentation.
  • Strapi tutorials - List of tutorials made by the core team and the community.
  • Strapi blog - Official Strapi blog containing articles made by the Strapi team and the community.
  • Changelog - Find out about the Strapi product updates, new features and general improvements.