How to Install Papercups on macOS

Papercups is an open-source customer messaging platform to bring a modern messaging experience to your customers. Here are the steps to install Papercups on macOS:

Prerequisites

  • macOS 10.15 (Catalina) or later
  • Node.js version 14 or later
  • Yarn package manager installed

Steps

  1. Open a Terminal window on your macOS machine.

  2. Clone the Papercups codebase from the GitHub repository with the following command:

git clone https://github.com/papercups-io/papercups.git
  1. Navigate to the Papercups directory with the following command:
cd papercups
  1. Install the dependencies using Yarn with the following command:
yarn install
  1. Create a .env file at the root of the project with the following command:
touch .env
  1. Open the .env file in your preferred text editor and add the following environment variables:
API_KEY=[your-papercups-api-key]
BASE_URL=https://app.papercups.io

Note: You can get your Papercups API key from the API keys section of your Papercups dashboard.

  1. Start the development server with the following command:
yarn dev

You should see a message in the Terminal indicating that the server is running on http://localhost:3000.

  1. Open your web browser and navigate to http://localhost:3000.

Congratulations! You have successfully installed Papercups on macOS. Now, follow the Papercups documentation to configure and use the platform.