36337ef3b3
* chore: Update README * Address feedback * Update README.md * Update README.md Co-authored-by: Shahed Nasser <shahednasser@gmail.com> --------- Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
<p align="center">
|
||
<a href="https://www.medusajs.com">
|
||
<img alt="Medusa" src="https://user-images.githubusercontent.com/59018053/228887024-f13c2620-2b21-4ed7-b712-38b5ec89cad9.svg" width="100" />
|
||
</a>
|
||
|
||
</p>
|
||
<h1 align="center">
|
||
Medusa
|
||
</h1>
|
||
|
||
<h4 align="center">
|
||
<a href="https://docs.medusajs.com">Documentation</a> |
|
||
<a href="https://www.medusajs.com">Website</a>
|
||
</h4>
|
||
|
||
<p align="center">
|
||
Building blocks for digital commerce
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
|
||
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Medusa is released under the MIT license." />
|
||
</a>
|
||
<a href="https://circleci.com/gh/medusajs/medusa">
|
||
<img src="https://circleci.com/gh/medusajs/medusa.svg?style=shield" alt="Current CircleCI build status." />
|
||
</a>
|
||
<a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md">
|
||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
|
||
</a>
|
||
<a href="https://www.producthunt.com/posts/medusa"><img src="https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E" alt="Product Hunt"></a>
|
||
<a href="https://discord.gg/xpCwq3Kfn8">
|
||
<img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
|
||
</a>
|
||
<a href="https://twitter.com/intent/follow?screen_name=medusajs">
|
||
<img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
|
||
</a>
|
||
</p>
|
||
|
||
## Getting Started
|
||
|
||
Visit the [Quickstart Guide](https://docs.medusajs.com/create-medusa-app) to set up a server.
|
||
|
||
Visit the [Docs](https://docs.medusajs.com/development/backend/prepare-environment) to learn more about our system requirements.
|
||
|
||
## What is Medusa
|
||
|
||
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.
|
||
|
||
Learn more about [Medusa’s architecture](https://docs.medusajs.com/development/fundamentals/architecture-overview) and [commerce modules](https://docs.medusajs.com/modules/overview) in the Docs.
|
||
|
||
## Roadmap, Upgrades & Plugins
|
||
|
||
You can view the planned, started and completed features in the [Roadmap discussion](https://github.com/medusajs/medusa/discussions/categories/roadmap).
|
||
|
||
Follow the [Upgrade Guides](https://docs.medusajs.com/upgrade-guides/) to keep your Medusa project up-to-date.
|
||
|
||
Check out all [available Medusa plugins](https://medusajs.com/plugins/).
|
||
|
||
## Community & Contributions
|
||
|
||
The community and core team are available in [GitHub Discussions](https://github.com/medusajs/medusa/discussions), where you can ask for support, discuss roadmap, and share ideas.
|
||
|
||
Our [Contribution Guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) describes how to contribute to the codebase and Docs.
|
||
|
||
Join our [Discord server](https://discord.com/invite/medusajs) to meet other community members.
|
||
|
||
## Other channels
|
||
|
||
- [GitHub Issues](https://github.com/medusajs/medusa/issues)
|
||
- [Twitter](https://twitter.com/medusajs)
|
||
- [LinkedIn](https://www.linkedin.com/company/medusajs)
|
||
- [Medusa Blog](https://medusajs.com/blog/)
|
||
|
||
## License
|
||
|
||
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE).
|