Installing Coral on macOS

Coral is an open-source platform that helps news organizations build better communities around their journalism. If you are interested in setting up Coral on your macOS device, follow the step-by-step guide below.

Prerequisites

Before installing Coral on your macOS, make sure you have the following software installed:

Installation

  1. Clone the Coral repository from GitHub by running the following command in the terminal:

$ git clone https://github.com/coralproject/talk

  1. Navigate to the cloned directory:

$ cd talk

  1. Rename the .env.sample file to .env:

$ mv .env.sample .env

  1. Create a new AWS access key and secret access key by following the instructions on the AWS documentation. These credentials are required to run the Coral development environment.

  2. Open the .env file in a text editor and replace the AWS_ACCESS_KEY and AWS_SECRET_KEY values with your newly created credentials.

  3. Start the Coral development environment by running the following command in the terminal:

$ make watch

This command will download and install all necessary dependencies and start a local server at http://localhost:3000.

  1. Navigate to http://localhost:3000 in your web browser to confirm that the Coral development environment is running successfully.

Congratulations, you have successfully installed Coral on your macOS device! You can now begin developing and testing Coral on your local machine.