Browse Source

Corrected readme structure according to feedback

Sebastian M. Nicolajsen 4 years ago
parent
commit
d80fbe992d
1 changed files with 17 additions and 6 deletions
  1. 17 6
      README.md

+ 17 - 6
README.md

@@ -2,19 +2,30 @@
 
 
 This repo provides the skeleton to get you started with using Medusa. Follow the steps below to get ready.
 This repo provides the skeleton to get you started with using Medusa. Follow the steps below to get ready.
 
 
+## Prerequisites
+- Have Postgresql installed and ensure it is running and initialized.
+    - `brew install postgresql`
+    - `brew services start postgresql`
+    - `createdb`
+
+- Install Redis and ensure that it is running.
+    - `brew install redis`
+    - `brew services start redis`
+
+- Have Yarn and related packages installed globally:
+    - Install yarn if needed `brew install yarn` 
+    - Install packages `yarn global add npm @babel/core`
+
+
+## Running Medusa
 - Copy the `.env.template` file to a `.env` file in the root directory
 - Copy the `.env.template` file to a `.env` file in the root directory
 - Setup a Stripe account and add your API key and webhook secret to your `.env`
 - Setup a Stripe account and add your API key and webhook secret to your `.env`
 - Setup a Sendgrid account and add your API key to your `.env`
 - Setup a Sendgrid account and add your API key to your `.env`
-- `yarn`
-- Make sure yarn has added npm and babel/core globally `yarn global add npm` and `yarn global add @babel/core`
-- Make sure redis and postgresql is running using `brew services start postgres` and `brew services start redis`
-- Make sure postgresql is running (and initialized) by using `createdb`
+- Install all dependencies `yarn`
 - Create a local postgres database using `psql -h localhost -c 'create database "medusa-development";'`
 - Create a local postgres database using `psql -h localhost -c 'create database "medusa-development";'`
 - Migrate the database `medusa migrations run`
 - Migrate the database `medusa migrations run`
 - Run `medusa develop`
 - Run `medusa develop`
 
 
-
-
 Your local Medusa server is now running on port 9000. 
 Your local Medusa server is now running on port 9000. 
 
 
 Visit docs.medusa-commerce.com for further guides.
 Visit docs.medusa-commerce.com for further guides.