Skip to content

RubyFireStudio/phoenix-api-scaffold

Repository files navigation

Reanix - React + Phoenix project template

Build Status

This is a basic setup for an React(16) + Phoenix(1.3)/Elixir(1.6) project, using webpack(3) and users with authentication.

STARTING PROJECT

git clone https://github.com/RubyFireStudio/phoenix-react-project-template appname
cd appname

Changing app name in files(commands for unix like systems)

grep -rl Reanix | xargs sed -i s@Reanix@Appname@g
grep --exclude={package.json,yarn.lock,.babelrc} -rl reanix | xargs sed -i s@reanix@appname@g
find . -depth -exec rename 's/reanix/appname/g' {} \; 

Reinit git

rm -rf .git
git init
git add priv/static/favicon.ico -f
git add priv/static/images/phoenix.png -f

Download dependencies

mix deps.get
mix ecto.create
mix ecto.migrate
(cd assets && yarn install)

Start server

mix phx.server

SUPERUSER

After running mix ecto.migrate command you will have superuser:

username: amdin
password: 12345678

You probably wanna change it :)

SETUP

Redux logger

If you want to turn redux logger on just assign true to useReduxLogger in app/store/index.js

...
const useReduxLogger = true;
...

DEPLOYING TO HEROKU

You should have installed heroku-cli

Create heroku application

heroku create --buildpack "https://github.com/HashNuke/heroku-buildpack-elixir.git"

Optional change app address

heroku apps:rename appname

Adding phoenix buildpack

heroku buildpacks:add https://github.com/chernyshof/heroku-buildpack-phoenix-static.git

Add you address

in config/prod.exs change in config, :appname, Reanix.Repo, url line(if needed)

url: [scheme: "https", host: "appnameaddress.herokuapp.com", port: 443],

Creating Environment Variables

heroku addons:create heroku-postgresql:hobby-dev
heroku config:set POOL_SIZE=18

Secret key

gen secret key

$ mix phx.gen.secret
xvafzY4y01jYuzLm3ecJqo008dVnU3CN4f+MamNd1Zue4pXvfvUjbiXT8akaIF53
now set key that you got in heroku
heroku config:set SECRET_KEY_BASE="xvafzY4y01jYuzLm3ecJqo008dVnU3CN4f+MamNd1Zue4pXvfvUjbiXT8akaIF53"

Guardian secret key

$ mix phx.gen.secret
xvafzY4y01jYuzLm3ecJqo008dVnU3CN4f+MamNd1Zue4pXvfvUjbiXT8akaIF53
now set key that you got in heroku
heroku config:set GUARDIAN_SECRET_KEY="xvafzY4y01jYuzLm3ecJqo008dVnU3CN4f+MamNd1Zue4pXvfvUjbiXT8akaIF53"

Deploy time!

git push heroku master
heroku run "POOL_SIZE=2 mix ecto.migrate"

REQUIREMENTS

USED PLUGINS AND TECHNOLOGIES

Frontend

Backend