Philip Korsholm
e2423020c0
* init * add query params * added buld id validation to repo * admin done * updated price reqs * initial price selection strategy * update customer seeder * format models * price selection strategy * price selection testing * update price selection tests * update price selection strategy * remove console.warn * update price seleciton strategy * use price selection strategy in "get-product" * price selection strategy integration testing * update integration tests * update price selection strat * remove console.log * fix unit tests * update product snapshot integration tests * fix failing unit tests * update variant test snapshots * update variant test snapshots * fix failing unit tests * update product snapshot integration tests * intial implementation of PriceList * add price selection strategy test to list-products * add price selection to list products * add price selection strategy to getRegionPrice * add price selection strategy to get variant * update product snapshot test * store testing of price selection * variant services * update cart service * update product tests * update test * unit testing with price selection strategy * integration tests for price lists * update sort prices for consistent results * update snapshot * update product snapshot with product ids * this time pipelines work * swap tests * redo ordering * updated admin/product integration tests * update updateVariantPrices method * remove comment from error handler * add integration test for batch deleting prices associated with price list * named ids * run with verbose * add console.log * sort products in integration test * remove verbose flag * make update to prices through variant service limited to default prices * update store/products.js snapshot * update comment * add todo * lift existing price calculations to variant level * remove unused import * add api unit tests and update product integration tests to validate that prices from Price List are ignored * fix product test * update integration tests * pre merge commit * requested changes * cascade * ensure delete variant cascades to MoneyAmount * fetch variants correctly * use find options * add pricelist to relevant seeders * update integration tests * update price selection with "includeDiscountPrices" * use transaction with price selection strategy * add await to prevent store test errors * remove verbose * addresses PR feedback * removed unused endpoint * remove unused repository from constructor * remove from constructor argument * update mock * update unit tests * fix failing store integration tests * remove medusajs ressource * re add env.template * price selection strategy methods * fix integration tests * update unit tests * remove commented out code * update jsdoc * update price selection strategy parameter * update snapshots * integration tests cleanup * pr feedback * update integration tests * pr feedback * price selection unit tests * add calculated price type to results * cleanup include discount prices and price selection configs * refactor price selection params to a separate file * update tests and refactor price selection seeder * remove prices from variant update * rename result * pr feedback * remove unused import * create getRegionPriceContext * remove from params in search * remove unused import Co-authored-by: Kasper <kasper@medusajs.com> Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
Medusa
Medusa Admin | Website | Roadmap | Blog | LinkedIn | Twitter | Documentation | Notion
Medusa is an open-source headless commerce engine that enables developers to create amazing digital commerce experiences.
Quickstart
- Install Medusa CLI
npm install -g @medusajs/medusa-cli - Create a new Medusa project
medusa new my-medusa-store --seed - Start your Medusa engine
medusa develop - Use the API
curl localhost:9000/store/products | python -m json.tool
We have a prebuilt admin dashboard that you can use to configure and manage your store find it here: Medusa Admin
After these four steps and only a couple of minutes, you now have a complete commerce engine running locally. You may now explore the documentation to learn how to interact with the Medusa API. You may also add plugins to your Medusa store by specifying them in your medusa-config.js file.
Roadmap 2022
Write-ups for all features will be made available in Github discussions prior to starting the implementation process.
Q1
- Admin revamp
- Tax API
- Strategy pattern
- Promotions API
- Bulk import / export
Q2
- Extended Product API (custom fields, price lists, publishing control, and more)
- Extended Order API (managing placed orders, improved inventory control, and more)
- Sales Channel API
- Multi-warehouse support
- GraphQL API
Setting up a storefront for your Medusa project
Medusa is a headless commerce engine which means that it can be used for any type of digital commerce experience - you may use it as the backend for an app, a voice application, social commerce experiences or a traditional e-commerce website, you may even want to integrate Medusa into your own software to enable commerce functionality. All of these are use cases that Medusa supports - to learn more read the documentation or reach out.
To provide a quick way to get you started with a storefront install one of our traditional e-commerce starters:
- Gatsby Starter
npm install -g gatsby-cli gatsby new my-medusa-storefront https://github.com/medusajs/gatsby-starter-medusa - Nextjs Starter
npx create-next-app -e https://github.com/medusajs/nextjs-starter-medusa my-medusa-storefront
With your starter and your Medusa store running you can open http://localhost:8000 (for Gatsby) or http://localhost:3000 (for Nextjs) in your browser and view the products in your store, build a cart, add shipping details and pay and complete an order.
Features
Medusa comes with a set of building blocks that allow you to create amazing digital commerce experiences, below is a list of some of the features that Medusa come with out of the box:
- Headless: Medusa is a highly customizable commerce API which means that you may use any presentation layer such as a website, app, chatbots, etc.
- Regions allow you to specify currencies, payment providers, shipping providers, tax rates and more for one or more countries for truly international sales.
- Orders come with all the functionality necessary to perform powerful customer service operations with ease.
- Carts allow customers to collect products for purchase, add shipping details and complete payments.
- Products come with relevant fields for customs, stock keeping and sales. Medusa supports multiple options and unlimited variants.
- Swaps allow customers to exchange products after purchase (e.g. for incorrect sizes). Accounting, payment and fulfillment plugins handle all the tedious work for you for automated customer service.
- Claims can be created if customers experience problems with one of their products. Plugins make sure to automate sending out replacements, handling refunds and collecting valuable data for analysis.
- Returns allow customers to send back products and can be configured to function in a 100% automated flow through accounting and payment plugins.
- Fulfillment API makes it easy to integrate with any fulfillment provider by creating fulfillment plugins, check the
/packagesdirectory for a full list of plugins. - Payments API makes it easy to integrate with any payment provider by creating payment plugins, we already support Stripe, Paypal and Klarna.
- Notification API allow integrations with email providers, chatbots, Slack channels, etc.
- Customer Login to give customers a way of managing their data, viewing their orders and saving payment details.
- Shipping Options & Profiles enable powerful rules for free shipping limits, multiple fulfillment methods and more.
- Medusa's Plugin Architecture makes it intuitive and easy to manage your integrations, switch providers and grow with ease.
- Customization is supported for those special use cases that all the other e-commerce platforms can't accommodate.
Database support
In production Medusa requires Postgres and Redis, but SQLite is supported for development and testing purposes. If you plan on using Medusa for a project it is recommended that you install Postgres and Redis on your dev machine.
To use Postgres and Redis you should provide a database_url and redis_url in your medusa-config.js.
Contribution
Medusa is all about the community. Therefore, we would love for you to help us build the most robust and powerful commerce engine on the market. Whether it is fixing bugs, improving our documentation or simply spreading the word, please feel free to join in. Please check our contribution guide for further details about how to contribute.
Repository structure
The Medusa repository is a mono-repository managed using Lerna. Lerna allows us to have all Medusa packages in one place, and still distribute them as separate NPM packages.
Licensed
Licensed under the MIT License