Skip to content

Commit

Permalink
readme: add homebrew install guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
sorax committed Oct 20, 2024
1 parent 3e28679 commit 28e10c2
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,34 @@ Radiator is the 100% open source podcast hosting project for the next century of

[![Test](https://github.com/podlove/radiator/actions/workflows/test.yml/badge.svg)](https://github.com/podlove/radiator/actions/workflows/test.yml) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

To start your Phoenix server:

- Run `mix setup` to install and setup dependencies
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

## Contributing

The Radiator team welcomes contributions from anyone who wishes to advance the development of the Radiator!

If you'd like to contribute, please note we have [contribution docs](CONTRIBUTING.md) and a [code of conduct](CODE_OF_CONDUCT.md). Please follow it in all your interactions with the people and the project.

## Setup

### Using Homebrew

Open a Terminal and run the following commands

#### Install Homebrew

- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`

#### Install & Start Postgres

- `brew install postgresql`
- `brew services start postgresql`
- `createuser -d postgres`

#### Install Elixir

- `brew install elixir`

#### Setup and Start Radiator

- Run `mix setup` to install and setup dependencies
- Start Radiator with `mix phx.server`
- Visit [`localhost:4000`](http://localhost:4000) from your browser

0 comments on commit 28e10c2

Please sign in to comment.