Syncs GitHub issues and comments with linear.app
Environment requirements:
Start local postgres service
$ docker-compose up
Setting up the application:
- Start an ngrok session:
ngrok http 4000
- Copy
config/dev.secret.template.exs
toconfig/dev.secret.exs
- Configure
ngrok_host
inconfig/dev.secret.exs
- Configure
Linear.Repo
inconfig/dev.secret.exs
- Configure
Linear.Auth.Github
inconfig/dev.secret.exs
(see: Creating a GitHub App) withrepo
scope - Setup the project with
mix setup
- Start Phoenix endpoint with
iex -S mix phx.server
Now you can visit the URL provided by ngrok
from your browser to access the application.
Webhook requests from GitHub or Linear cannot target localhost
, so while
in development we use ngrok
to expose the application to the internet. Phoenix
uses this URL when configuring webhooks, therefore allowing the application to
receive webhook requests while still running locally.
- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix