Skip to content
This repository has been archived by the owner on Oct 13, 2021. It is now read-only.

Commit

Permalink
Add thoughtbot branding to README
Browse files Browse the repository at this point in the history
Also cleaned up the formatting and removed some info left over from the
days of the React frontend.
  • Loading branch information
derekprior committed Jun 24, 2016
1 parent 56ebed2 commit c136718
Showing 1 changed file with 30 additions and 16 deletions.
46 changes: 30 additions & 16 deletions README.md
@@ -1,5 +1,7 @@
# Constable

**Constable is part of the [thoughtbot Elixir family][elixir-phoenix] of projects.**

Constable is a Phoenix app for posting announcements and having discussions.
To learn more about Phoenix, check out [Programming Phoenix](https://pragprog.com/book/phoenix/programming-phoenix)

Expand All @@ -13,32 +15,32 @@ start the console in staging or production.
To set up your development environment, there are a few steps you'll need to
follow.

### Install Elixir and Phantomjs
### Install Elixir and PhantomJS

If you're on OS X and using Homebrew, run `brew install elixir` and `brew
install phantomjs`. Otherwise, follow the instructions on the [Elixir
installation page] and the [Phantomjs page].
installation page] and the [PhantomJS page].

[Elixir installation page]: http://elixir-lang.org/install.html
[Phantomjs page]: http://phantomjs.org/download.html
[PhantomJS page]: http://phantomjs.org/download.html

### Configure Your Local Environment

Run:

```sh
# Will grab all Elixir and NPM dependencies and then setup the database
bin/setup
$ bin/setup
```

### Starting the Phoenix Server

Once all the dependencies have been installed, you can start the Phoenix
server with:

```sh
mix phoenix.server
```
```sh
$ mix phoenix.server
```

## Email Templates

Expand All @@ -64,20 +66,32 @@ change, delete `.dialyzer.plt` and run `mix dialyzer.plt` to rebuild it.
There are still a lot of warnings that are not fixable, but occasionally some
real errors are found by dialyzer

## Using the Constable API

Visit the [thoughtbot/constable repo](http://github.com/thoughtbot/constable) to
see how to use the API.
The [app/stores](https://github.com/thoughtbot/constable/tree/master/app/stores)
folder has a few the best examples.

## Deployment

1. If you have not run `bin/setup` yet, run it to add the correct git remotes.
2. Run `bin/deploy (staging|production)`

## Review Apps

Constable is setup with support for [Heroku Review Apps](https://devcenter.heroku.com/articles/github-integration-review-apps).
Constable is setup with support for [Heroku Review Apps].

Google enforces a white list of OAuth redirect URLs, so for review apps we
redirect the OAuth flow through the [Constable oauth redirector] which then
redirects back to the correct review app. This is configured with the
`OAUTH_REDIRECT_OVERRIDE` environment variable.

[Heroku Review Apps]: https://devcenter.heroku.com/articles/github-integration-review-apps
[Constable oauth redirector]: https://github.com/thoughtbot/constable-oauth-redirector

## About thoughtbot

![thoughtbot](https://thoughtbot.com/logo.png)

Constable is maintained and funded by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software, Elixir, and Phoenix. [Work with thoughtbot's
Elixir development team][elixir-phoenix] to design, develop, and grow your
product.

Google enforce a whitelist of OAuth redirect URLs, so for review apps we redirect the OAuth flow through [thoughtbot/constable-oauth-redirector](https://github.com/thoughtbot/constable-oauth-redirector) which then redirects back to the correct review app. This is configured with the `OAUTH_REDIRECT_OVERRIDE` environment variable.
[elixir-phoenix]: https://thoughtbot.com/services/elixir-phoenix?utm_source=github

0 comments on commit c136718

Please sign in to comment.