https://github.com/carbonfive/razor-phoenix
Phoenix application prototype for Razor, the Carbon Five Phoenix application generator. https://github.com/carbonfive/razor
https://github.com/carbonfive/razor-phoenix
Last synced: 12 months ago
JSON representation
Phoenix application prototype for Razor, the Carbon Five Phoenix application generator. https://github.com/carbonfive/razor
- Host: GitHub
- URL: https://github.com/carbonfive/razor-phoenix
- Owner: carbonfive
- Created: 2017-02-10T01:05:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-01T03:41:59.000Z (about 8 years ago)
- Last Synced: 2025-06-27T22:03:42.271Z (12 months ago)
- Language: Elixir
- Homepage:
- Size: 213 KB
- Stars: 12
- Watchers: 46
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Phoenix Prototype app
A Carbon Five-flavored convenience skeleton project for Phoenix.
* [Phoenix](https://hex.pm/packages/phoenix)
* [Postgrex](https://hex.pm/packages/postgrex)
* [Slim](https://hex.pm/packages/slime)
* [Wallaby](https://hex.pm/packages/wallaby)
* [ExMachina](https://hex.pm/packages/ex_machina)
* Yarn
* Sass
* Bootstrap
* additional `acceptance` environment
* CI testing via CircleCI
* .iex.exs for REPL aliases & imports
* ready for deployment to Heroku Pipelines in `acceptance` and `prod` environments.
## Automatic installation
It's strongly recommended you don't clone this repo, and instead [zap your project using Razor](https://github.com/carbonfive/razor).
The zapper will handle all of the following steps programmatically.
## Manual installation
If you can't use [Razor](https://github.com/carbonfive/razor) to install for some reason, you can start by cloning this repo.
Next, you'll perform global replacements for these with your app name:
* `AppPrototype`
* `app_prototype`
* `app-prototype`
* `App Prototype`
Also rename the following directories & files:
* `/lib/app_prototype`
* `/web/static/css/_app_prototype.scss`
* `/web/static/js/app_prototype.js`
Now you can finish your setup & verify things are working:
* `mix deps.get`
* `mix ecto.setup`
* `cd assets && yarn install`
* `cd assets && ./node_modules/.bin/brunch build`
* `mix test`
## Running the server
Each environment is responsible for setting the `SECRET_KEY_BASE`. With the exception of the `test` environment, this value is derived from a system environment variable.
To set environment variables locally for the `dev` environment, you can create a `.env` file & run the server with a tool that reads `.env`. I recommend `heroku local` to mirror production more closely, or foreman.
#### Sample `.env` file
```
MIX_ENV=dev
SECRET_KEY_BASE="xxxxxx"
```
`SECRET_KEY_BASE` can be generated with the task `mix phx.gen.secret`.
As a convenience, a weak `SECRET_KEY_BASE` is hard-coded in the `test` environment. You can easily change this to read an env var a la the other environments instead.
#### Give it a spin:
* Run with something that works with `.env` files, i.e. `foreman` or `heroku local`
* OR `source .env` and `mix phx.server`
* visit the app in a browser (default is `http://localhost:4000`, or `http://127.0.0.1:4000` in some versions of Chrome)
Now you're ready to remove demo content, which is easy to spot from the landing page.
## Requirements
* phantomjs is required for acceptance testing with Wallaby, i.e. `yarn global add phantomjs`.
[Lean more about wallaby](https://github.com/keathley/wallaby)
## Recommendations
* If you use [asdf](https://github.com/asdf-vm/asdf), you'll be set up with the correct versions of `node` and `elixir` once they're installed. Otherwise, have a look at `.tool-versions` to see the current versions.
## Deployment
This app is pre-configured for easy deployment to Heroku w/ pipelines using CircleCI. CI is only used to run tests; your pipelines should be configured to auto-deploy branches after passing CI tests.
Convention is to auto-deploy `master` branch to `acceptance`, and `production` branch to `production`.
* Create Heroku apps for `acceptance` and `production`
* Provision Heroku Postgres DB resources
* Add buildpacks to Heroku apps
* `heroku buildpacks:add https://github.com/HashNuke/heroku-buildpack-elixir.git --app your-heroku-app-name`
* `heroku buildpacks:add https://github.com/gjaldon/heroku-buildpack-phoenix-static.git --app your-heroku-app-name`
* Add environment variables to Heroku
* `SECRET_KEY_BASE`, which can be generated with the task `mix phx.gen.secret`
* `HOSTNAME`, should be the hostname of the deployed site (e.g. `app-prototype-production.herokuapp.com`)
* `MIX_ENV` should be `prod`
* `POOL_SIZE` should be set 2 units below the max db connections allowed by the Heroku instance. This allows mix tasks to be run with 2 connections.
* `DATABASE_URL` should have been filled automatically by provisioning heroku postgres.
* Migrations are run automatically using Heroku's [release phase](https://devcenter.heroku.com/articles/release-phase).
* Configure Elixir, Erlang and Node versions via the `elixir_buildpack.config` and `phoenix_static_buildpack.config` files. See the corresponding buildpack project pages for more configuration variables.
## Notes
* You will see warnings from several dependencies the first time they're compiled.
This is because many of them have not yet been upgraded for elixir 1.4; these can be safely ignored.
* There's a decent chance you'll eventually want a production environment with more control & power. Heroku is currently the simplest way to get up & running for prototyping, and may even suit your app just fine long term.
* Razor should be used for convenience, not to avoid learning more about Phoenix and Elixir. Please take the time to learn about the opinions provided by Razor & how they are implemented.
## Learn more about Phoenix
* Official website: http://www.phoenixframework.org/
* Guides: http://phoenixframework.org/docs/overview
* Docs: https://hexdocs.pm/phoenix
* Mailing list: http://groups.google.com/group/phoenix-talk
* Source: https://github.com/phoenixframework/phoenix