asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update readme (#2587)

Browse Source 
* docs: added features list

* docs: update readme
This commit is contained in:
Shahed Nasser
2022-11-10 17:52:03 +02:00
committed by GitHub
parent 7b96bb1f1a
commit 208809b635
3 changed files with 44 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -37,51 +37,21 @@ An open source composable commerce engine built for developers.
## Getting Started ## Getting Started
You can install Medusa by either following our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start) or the following steps: Follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to learn how to set up a Medusa server.
1. **Install Medusa CLI**
```bash
npm install -g @medusajs/medusa-cli
```
2. **Create a new Medusa project**
```bash
medusa new my-medusa-store --seed
```
3. **Start your Medusa engine**
```bash
cd my-medusa-store
medusa develop
```
### Requirements ### Requirements
- Node v14.0 or higher. You can check out [this documentation for details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
- SQLite or PostgreSQL (SQLite is only for getting started; PostgreSQL is recommended)
- Redis
You can check out [this documentation for more details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment). ## What is Medusa
## What is Medusa?
Medusa is an open source composable commerce engine built with Node.js. Medusa enables developers to build scalable and sophisticated commerce setups with low effort and great developer experience. Medusa is an open source composable commerce engine built with Node.js. Medusa enables developers to build scalable and sophisticated commerce setups with low effort and great developer experience.
You can learn more about [Medusa’s architecture in our documentation](https://docs.medusajs.com/introduction). You can learn more about [Medusa’s architecture in our documentation](https://docs.medusajs.com/introduction#architecture).
### Features ### Features
- **Orders, Exchanges, and Returns APIs:** Aside from the standard order management that comes with ecommerce platforms, Medusa also provides an easy and automated way to manage swaps, returns, and claims. You can learn about all of the ecommerce features that Medusa provides [in our documentation](https://docs.medusajs.com/introduction#features).
- **Products and Collections APIs:** Add products with extensive customization settings and sort them into collections.
- **Region API:** Configure and manage multiple regions and currencies all from one platform.
- **Plugin API:** Easily integrate fulfillment providers, payment providers, notification services, and many other custom tools and third-party services.
- ****PriceList and Promotions APIs:**** Advanced pricing for products with conditions based on the amount in the cart or promotions and discounts.
- **Tax API:** Advanced tax configurations specific to multiple regions, with the capability of specifying taxes for specific products.
See more of the [ecommerce features on our documentation](https://docs.medusajs.com/#features).
## Roadmap ## Roadmap
@@ -106,15 +76,15 @@ Write-ups for all features will be made available in [Github discussions](https
## Plugins ## Plugins
As a headless and extendible solution, Medusa allows you to integrate third-party services or add custom features to Medusa by installing Plugins.
Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server. Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server.
## Contributions ## Contributions
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. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for details about how to contribute to both our codebase and our documentation.
Whether it is fixing bugs, improving our documentation, or simply spreading the word, please feel free to join in. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for further details about how to contribute. ## Upgrade Guides
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
## Community & Support ## Community & Support
@@ -127,10 +97,6 @@ Use these channels to be part of the community, ask for help while using Medusa,
- [Twitter](https://twitter.com/medusajs) - [Twitter](https://twitter.com/medusajs)
- [LinkedIn](https://www.linkedin.com/company/medusajs) - [LinkedIn](https://www.linkedin.com/company/medusajs)
## Upgrade Guides
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
## License ## License
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE) Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE)

28
docs/content/introduction.md
View File

@@ -1,20 +1,18 @@
--- # Overview
title: Architecture Overview
---
# Architecture Overview ## Architecture
Medusa is composed of three components: The headless backend, the admin dashboard, and the storefront. Medusa is composed of three components: The headless backend, the admin dashboard, and the storefront.
![Medusa's Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999772/Medusa%20Docs/Diagrams/ZHvM2bu_td4rnx.png) ![Medusa's Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999772/Medusa%20Docs/Diagrams/ZHvM2bu_td4rnx.png)
## Headless Backend ### Headless Backend
This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs. This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs.
Your Medusa server will include all functionalities related to your store’s checkout workflow. That includes cart management, shipping and payment providers, user management, and more. It also allows you to configure your store including your store’s region, tax rules, discounts, gift cards, and more. Your Medusa server will include all functionalities related to your store’s checkout workflow. That includes cart management, shipping and payment providers, user management, and more. It also allows you to configure your store including your store’s region, tax rules, discounts, gift cards, and more.
## Admin Dashboard ### Admin Dashboard
The admin dashboard is accessible by store operators. Store operators can use the admin dashboard to view, create, and modify data such as orders and products. The admin dashboard is accessible by store operators. Store operators can use the admin dashboard to view, create, and modify data such as orders and products.
@@ -22,6 +20,22 @@ Medusa provides a beautiful [admin dashboard](https://demo.medusajs.com) that yo
You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin). You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin).
## Storefront ### Storefront
Your customers use the Storefront to view products and make orders. Medusa provides two storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/). Your customers use the Storefront to view products and make orders. Medusa provides two storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/).
---
## Features
- [Orders, Exchanges, and Returns](./user-guide/orders/index.md): Aside from the standard order management that comes with ecommerce platforms, Medusa also provides an easy and automated way to manage swaps, returns, and claims.
- [Customers and Customer Groups](./user-guide/customers/index.md): Manage Customers and assign them to customer groups.
- [Products and Collections](./user-guide/products/index.mdx): Add products with extensive customization settings and sort them into collections.
- [Region](./user-guide/regions/index.md): Configure and manage multiple regions and currencies all from one platform.
- [Plugins](./advanced/backend/plugins/overview.md): Easily integrate fulfillment providers, payment providers, notification services, and many other custom tools and third-party services.
- [PriceList](./user-guide/price-lists/index.md) and [Discounts](./user-guide/discounts/): Advanced pricing for products with conditions based on the amount in the cart or promotions and discounts.
- [Taxes](./user-guide/taxes/index.md): Advanced tax configurations specific to multiple regions, with the capability of specifying taxes for specific products.
- [Sales Channels](./user-guide/sales-channels/index.md): Create multiple sales channels and control which sales channels products are available in.
- [Bulk Import](./user-guide/products/import.mdx): Bulk import strategies for different entities including [products](./advanced/admin/import-prices.mdx) and [price lists](./advanced/admin/import-prices.mdx).
- [Bulk Export](./user-guide/products/export.mdx): Bulk export strategies for different entities including [products](./user-guide/products/export.mdx) and [orders](./user-guide/orders/export.mdx).
- Complete Customization Capabilities: Aside from all the features that Medusa provides, it is completely customizable providing capabilities to create custom [endpoints](./advanced/backend/endpoints/add.md), [services](./advanced/backend/services/create-service.md), [subscribers](./advanced/backend/subscribers/create-subscriber.md), [batch job strategies](./advanced/backend/batch-jobs/create.md), and much more!

62
packages/medusa/README.md
View File

@@ -14,7 +14,7 @@
</h4> </h4>
<p align="center"> <p align="center">
An open-source composable commerce engine built for developers. An open source composable commerce engine built for developers.
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE"> <a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
@@ -37,34 +37,11 @@ An open-source composable commerce engine built for developers.
## Getting Started ## Getting Started
You can install Medusa by either following our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start) or the following steps: Follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to learn how to set up a Medusa server.
1. **Install Medusa CLI**
```bash
npm install @medusajs/medusa-cli -g
```
2. **Create a new Medusa project**
```bash
medusa new my-medusa-store --seed
```
3. **Start your Medusa engine**
```bash
cd my-medusa-store
medusa develop
```
### Requirements ### Requirements
- Node v14.0 or higher. You can check out [this documentation for details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
- SQLite or PostgreSQL (SQLite is only for getting started; PostgreSQL is recommended)
- Redis
You can check out [this documentation for more details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
## What is Medusa ## What is Medusa
@@ -74,18 +51,11 @@ You can learn more about [Medusa’s architecture in our documentation](https://
### Features ### Features
- **Orders, Exchanges, and Returns APIs:** Aside from the standard order management that comes with ecommerce platforms, Medusa also provides an easy and automated way to manage swaps, returns, and claims. You can learn about all of the ecommerce features that Medusa provides [in our documentation](https://docs.medusajs.com/#features).
- **Products and Collections APIs:** Add products with extensive customization settings and sort them into collections.
- **Region API:** Configure and manage multiple regions and currencies all from one platform.
- **Plugin API:** Easily integrate fulfillment providers, payment providers, notification services, and many other custom tools and third-party services.
- ****PriceList and Promotions APIs:**** Advanced pricing for products with conditions based on its amount in the cart or promotions and discounts.
- **Tax API:** Advanced tax configurations specific to multiple regions, with capability of specifying taxes for specific products.
See more of the [ecommerce features on our documentation](https://docs.medusajs.com/#features).
## Roadmap ## Roadmap
Write-ups for all features will be made available in [Github discussions](https://github.com/medusajs/medusa/discussions) prior to starting the implementation process. Write-ups for all features will be made available in [Github discussions](https://github.com/medusajs/medusa/discussions) before starting the implementation process.
### **2022** ### **2022**
@@ -97,24 +67,24 @@ Write-ups for all features will be made available in [Github discussions](https
- [x] Promotions API - [x] Promotions API
- [x] Price Lists API - [x] Price Lists API
- [x] Price Selection Strategy - [x] Price Selection Strategy
- [ ] Import / Export API - [x] Import / Export API
- [ ] Sales Channel API - [x] Sales Channel API
- [ ] Extended Order API (managing placed orders)
- [ ] PaymentCollection API (collecting payments separate from carts and draft orders)
- [ ] Multi-warehouse API
- [ ] Extended Product API (custom fields, publishing control, and more) - [ ] Extended Product API (custom fields, publishing control, and more)
- [ ] Extended Order API (managing placed orders, improved inventory control, and more)
- [ ] Multi-warehouse support
- [ ] GraphQL API
## Plugins ## Plugins
As a headless and extendible solution, Medusa allows you to integrate third-party services or add custom features into Medusa by installing Plugins.
Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server. Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server.
## Contributions ## Contributions
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. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for details about how to contribute to both our codebase and our documentation.
Whether it is fixing bugs, improving our documentation or simply spreading the word, please feel free to join in. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for further details about how to contribute. ## Upgrade Guides
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
## Community & Support ## Community & Support
@@ -127,10 +97,6 @@ Use these channels to be part of the community, ask for help while using Medusa,
- [Twitter](https://twitter.com/medusajs) - [Twitter](https://twitter.com/medusajs)
- [LinkedIn](https://www.linkedin.com/company/medusajs) - [LinkedIn](https://www.linkedin.com/company/medusajs)
## Upgrade Guides
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
## License ## License
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE) Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE)