Git Product home page Git Product logo

dev_wizard's Introduction

DevWizard

Heroku Stories in Ready Build Status

DevWizard is an Elixir/Phoenix application to help automate our workflow.

Setup

Instructions are written for setup and usage on Mac OSX, but should work on other supported platforms as well.

Run Locally

Requirements/Dependencies

  1. Elixir: http://elixir-lang.org/
  2. Node.js: https://nodejs.org/en/
  3. Postgres: http://www.postgresql.org/

Setup

  1. Install Elixir: $ brew update && brew install elixir
  2. Install dependencies: $ mix deps.get
  3. Create and migrate your database: $ mix ecto.create && mix ecto.migrate
  4. Create a file called secret_vars.sh. See section on secret_vars.sh for details.

Note: You may have to run $ npm install when prompted.

secret_vars.sh

This file contains sensitive keys and should not be committed to source control. This file is required to run the DevWizard. Create your own version with your GitHub application keys.

The file should contain the following lines:

export DW_GH_CLIENT_ID=<YOUR GITHUB CLIENT ID>
export DW_GH_CLIENT_SECRET=<YOUR GITHUB CLIENT SECRET>
export DW_GH_ORGANIZATION=<YOUR GITHUB ORGANIZATION>
export DW_GH_REPOSITORIES=<YOUR GITHUB REPOSITORIES>
export DW_GH_STORYBOARD_REPO=<YOUR GITHUB STORYBOARD REPO>

Note: Replace <...> with your GitHub client ID and client secret key.

Note: You may need to setup these keys through GitHub.

For details, see: https://github.com/settings/applications/new

Running

Start your Phoenix app endpoint: $ ./run_development.sh

Now you can visit localhost:4000 from your browser.

Deploy

Automatic deploys are setup on Heroku for any push to the master branch, so you may not need to do anything more than this to deploy. However, you can manually deploy using the steps below, if required.

Setup

  1. Install Heroku: $ brew install heroku
  2. $ heroku login
  3. $ heroku git:remote -a dev-wizard

Deploying

To deploy to production, run: $ git push heroku master

Learn more

More

Ask in issues

dev_wizard's People

Contributors

anthlam avatar joelmccracken avatar jwrubel avatar seejee avatar srobbibaro avatar tanookimario avatar thejefe avatar waffle-iron avatar ybur-yug avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.