Skip to content

Commit

Permalink
docs: revise intro pages (#10182)
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser authored Nov 20, 2024
1 parent 544f5d4 commit bef89e4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 16 deletions.
12 changes: 6 additions & 6 deletions www/apps/book/app/learn/installation/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ In this documentation, you'll learn how to install and run a Medusa application.

## Create Medusa Application

A Medusa application is made up of a headless Node.js server and an admin dashboard. You can optionally install a separate [Next.js storefront](../storefront-development/nextjs-starter/page.mdx) either while installing the Medusa application or at a later point.

<Prerequisites items={[
{
text: "Node.js v20+",
Expand All @@ -35,20 +37,18 @@ When you run the command, you'll be asked for the project's name and whether you

After answering the prompts, the command installs the Medusa application in a directory with your project name, and prepares a PostgreSQL database that the application connects to.

<Note>

Since the Medusa server is headless, the storefront is optional to install and you can install it later by following [this guide](../storefront-development/nextjs-starter/page.mdx). If you choose to install it with the Medusa application, the storefront is installed in a separate directory named `{project-name}-storefront`.

</Note>
If you chose to install the storefront with the Medusa application, the storefront is installed in a separate directory named `{project-name}-storefront`.

### Successful Installation Result

Once the Medusa application installation finishes successfully, the Medusa application will run at `http://localhost:9000`.
Once the installation finishes successfully, the Medusa application will run at `http://localhost:9000`.

The Medusa Admin dashboard also runs at `http://localhost:9000/app`. The installation process opens the Medusa Admin dashboard in your default browser to create a user. You can later log in with that user.

If you also installed the Next.js storefront, it'll be running at `http://localhost:8000`.

You can stop the servers for the Medusa application and Next.js storefront by exiting the installation command. To run the server for the Medusa application again, refer to [this section](#run-medusa-application-in-development).

### Troubleshooting Installation Errors

If you ran into an error during your installation, refer to the following troubleshooting guides for help:
Expand Down
33 changes: 23 additions & 10 deletions www/apps/book/app/learn/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,21 @@ Medusa is a digital commerce platform with a built-in framework for customizatio

Medusa ships with three main tools:

1. A suite of commerce modules that provide core commerce functionalities, such as tracking inventory, calculating cart totals, accepting payments, managing orders, and much more.
2. A framework to build custom functionalities specific to your business, product, or industry. This includes tools for introducing custom API endpoints, business logic, and data models; building workflows and automations; and integrating with third-party services.
1. A suite of [commerce modules](!resources!/commerce-modules) with core commerce functionalities, such as tracking inventory, calculating cart totals, accepting payments, managing orders, and much more.
2. A framework with the [architecture](./advanced-development/architecture/overview/page.mdx) to build custom functionalities specific to your business, product, or industry. This includes tools for introducing custom API endpoints, business logic, and data models; building workflows and automations; and integrating with third-party services.
3. A customizable admin dashboard for merchants to configure and operate their store.

When you start Medusa the first time you get a fully fledged commerce platform with all the features you need to get off the ground.
When you install Medusa, you get a fully fledged commerce platform with all the features you need to get off the ground. However, unlike other platforms, Medusa is built with customization in mind. You don't need to build hacky workarounds that are difficult to maintain and scale.

However, unlike other platforms, Medusa is built with customization in mind. You don't need to build hacky workarounds that are difficult to maintain and scale. Instead, you can focus on building features that brings your business's vision to life.
Your efforts go into building features that brings your business's vision to life.

---

## Who should use Medusa

Medusa is for businesses with unique requirements that other digital commerce platforms can't easily support. Businesses of any size can use Medusa, from small startups to large enterprises - all it takes is a developer to manage and deploy your project.
Medusa is for businesses and teams looking for a digital commerce platform with the tools to implement unique requirements that other platforms aren't built to support.

Businesses of all sizes can use Medusa, from small start ups to large enterprises. Also, technical teams of all sizes can build with Medusa; all it takes is a developer to manage and deploy Medusa projects.

Below are some stories from companies that use Medusa:

Expand Down Expand Up @@ -70,14 +72,25 @@ Below are some stories from companies that use Medusa:

## Who is this documentation for

This documentation is for developers looking to master Medusa. The documentation is structured to gradually introduce Medusa's concepts, from basic to advanced, with easy-to-follow examples to assist you along the way.
This documentation introduces you to Medusa's concepts and how they help you build your business use case. The documentation is structured to gradually introduce Medusa's concepts, with easy-to-follow examples along the way.

By the end of this documentation, you’ll be able to create custom commerce experiences that would otherwise take large engineering teams months to build.
By following this documentation, you’ll be able to create custom commerce experiences that would otherwise take large engineering teams months to build.

### How to use the documentation

The documentation for Medusa v2 is split into the following sections:
This documentation is split into the following sections:

1. The main documentation, which is the one you're currently viewing. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them.
1. The main documentation, which is the one you're currently reading. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them.
2. The [Development Resources documentation](!resources!) provides guides and resources useful during your development, such as tools, API references, recipes, step-by-step guides and examples, and more.
3. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types, and more.
3. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types in requests, and more.

To get started, check out the [Installation chapter](./installation/page.mdx).

---

## Useful Links

- Need Help? Refer to our [GitHub repository](https://github.com/medusajs/medusa) for [issues](https://github.com/medusajs/medusa/issues) and [discussions](https://github.com/medusajs/medusa/discussions).
- [Join the community on Discord](https://discord.gg/medusajs).
- Have questions or need more support? Contact our [sales team](https://medusajs.com/contact/).
- Facing issues in your development? Refer to our [troubleshooting guides](!resources!/troubleshooting).

0 comments on commit bef89e4

Please sign in to comment.