ezhao / papercups

Open-source customer chat software

Home Page:https://app.papercups.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Papercups

The code behind app.papercups.io

dashboard-v1

One click Heroku deployment

Deploy

Getting started

To start your server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Start the server with mix phx.server

This will automatically start up the React frontend in watch mode on localhost:3000, with the API running on localhost:4000.

To start client side

The frontend code will start up automatically when you run mix phx.server, but for more information see: assets/README.md

Setting up email alerts

Set the environment variables in the .env.example file.

At the moment we only support Mailgun — other messaging channels are coming soon!

Running tests

Create a PostgreSQL test database named: chat_api_test, and run:

mix test

Deploying

We currently use Heroku for deployments:

git push heroku master

Running compiler on file change

Note: Make sure you are running this inside of ChatApi otherwise it'll trigger on UI changes

./scripts/compile_watch.sh

Learn more about Phoenix

About

Open-source customer chat software

https://app.papercups.io

License:MIT License


Languages

Language:Elixir 61.8%Language:TypeScript 37.1%Language:HTML 0.7%Language:CSS 0.3%Language:Shell 0.1%Language:JavaScript 0.0%