The podcast showcase & community / Phoenix based web application
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Panoptikum

Panoptikum (or short Pan) is a webapplication written in Phoenix that represents a podcast discovery and community website.

It is licensed under the AGPL license. The project website with more information on the project can be found at https://www.panoptikum.io If you are interested and want to get in touch, write an email to Stefan.

Setup

📋 Prerequirements

  • Make sure you have Elixir installed.
  • Make sure you have Node.js installed.
  • Make sure you have PostgreSQL installed and running.
  • Make sure you have Elasticsearch installed and running.

📦 Install dependencies

  • Install Elixir's dependencies with mix deps.get
  • Install Node.js dependencies with npm install inside the assets folder

🛠 Configuration

  • Copy config/dev.secret.exs.example to config/dev.secret.exs and insert your own data
  • Copy config/prod.secret.exs.example to config/prod.secret.exs and insert your own data

📚 Database and demo data

  • Setup your database with mix ecto.setup
  • Import demo data
    • Uncompress materials/pan_dev.sql.gz
    • Import data with psql pan_dev < pan_dev.sql inside the materials folder
    • Seed an admin user with mix run priv/repo/seeds.exs that has the credentials user admin and password changeme

Run locally

  • Start Phoenix endpoint with mix phx.server
  • Now you can visit localhost:4000 from your browser.
  • Login as Admin using username admin and password changeme

🌡 Testing

  • Run tests with mix test

Bonus