Getting Started

To get started, please make sure you have created a free account at Once you have an account, you can go to the settings tab and enter a whitelisted URL where your dashboard will be hosted or a tunnel URL when developing locally (e.g. ngrok).

Clone the Repo#

git clone

Expose Your Localhost to the Internet#

  1. Download ngrok
  2. Open terminal and navigate to where ngrok was downloaded.
  3. If you’re working on OSX or Linux, start ngrok with ./ngrok http 3000. If you’re on Windows, start ngrok with ngrok http 3000.
  4. A url ending in will be shown in your terminal.
  5. Go to and enter this URL in the text box and click save.

Start the Application#

Run the following commands to run it in your local machine:

$ cd openship
$ yarn install
$ yarn dev

Go to the URL from before and log into Openship using your ceredentials. Now you can customize the application and the results will be hotloaded on the URL. Check out the Micro Apps tutorial to build your first customization.


Since Openship is a Next.js application, deployment is very easy with Make sure you have an account and have either the desktop application or CLI installed. Then run:

$ now

Once complete, you will have a URL ending with Enter this URL in your settings page and replace the prodFront variable in the config.js file.

Adding Shops#

Adding shops to your own instance can be done in two ways.

  1. Add it directly on and then you can access it on your instance
  2. Make a Shopify Partner account and create an app. Add a .env file to the root folder like so:

Now when you add a shop from your URL, the app you created will be installed in the shop instead of Openship.

Copyright © 2020 Openship

Documentation theme by Segun Adebayo