804a2f6ed9
* docs: adds installation guide for tutorial * docs: adds creating your medusa server guide * add quick starter * rename to reflect docker usage * docs: adds custom functionality tutorial * docs: adds linking with medusa cloud * fix: PR Co-authored-by: olivermrbl <oliver@mrbltech.com>
2.7 KiB
Quick Start w. Docker
This quick start is intended for developers, that have already configured their local development environment and familiarised them selves with all the technologies and frameworks used throughout the Medusa eco-system.
If this is not the case, please head over to our Getting Started tutorial for a thorough walkthrough.
Introduction
With all the tools and technologies in place, let's get started by setting up a default project. Our starter is shipped with a very basic configuration, that includes the following plugins:
- Stripe as payment provider
- SendGrid as email notification provider
- Manual fulfilment as fulfilment provider
Additionally, we will spin up a PostgreSQL database and a Redis server, both required for Medusa to run. In this quick start, we will use docker to seamlessly set up these resources.
Get started
- Clone our starter project from Github
git clone https://github.com/medusajs/medusa-starter-default.git my-medusa-starter
- Once cloned, we will jump into our project directory and get started with our configuration.
cd my-medusa-starter
- Get your environment variables ready using our template
mv .env.template .env
- Setup accounts for included plugins. This step is optional but required for placing orders.
Create a Stripe account and add your API key and webhook secret to .env
Create a SendGrid account and add your API key to .env
...
STRIPE_API_KEY="some_stripe_key"
STRIPE_WEBHOOK_SECRET="some_webhook_secret"
SENDGRID_API_KEY="some_sendgrid_key"
..
- Start your server
docker-compose up --build
We will use docker-compose and Docker to start up our development environment. Running the above command will do the following:
-
Build images for our Medusa project, a PostgreSQL database and a Redis server
-
Run migrations for our newly created database
-
Seed our database with some entities, that will allow us to easily get started.
These include:
- A user with email
admin@medusa-test.comand passwordsupersecret - A region called Default Region with a small subset of countries
- A shipping option called Standard Shipping, that costs 10 EUR
- A product called Cool Test Product
- A variant of that product that costs 195 EUR
- A user with email
Once done, our server will be accessible at http://localhost:9000.
Try it out
Let's try out our Medusa server by fetching some products.
curl -X GET localhost:9000/store/products | python -m json.tool
What's next?
Add custom endpoint to your Medusa project
Install and configure additional plugins
Build a storefront using our Gatsby Starter