Phoenix Documentation
Phoenix ProductionPhoenix PreviewContentful
Primary version
Primary version
  • 🔥Phoenix 🔥
  • Installation + Usage
    • Prerequisites
    • Installation
    • Usage
  • Development
    • Architecture
      • Heroku
    • Content Types
      • Action Stats Block
      • Campaign
      • Content Block
      • Cause Page
      • Company Page
      • Current Club Block
      • Current School Block
      • Embed
      • External Link
      • Landing Page
      • Link Action
      • Metadata
      • Page
      • Photo Submission Action
      • Selection Submission Action
      • Share Action
      • Signup Referrals Block
      • Social Drive Action
      • Voter Registration Action
      • Voter Registration Drive Action
      • Voter Registration Marketing Page
      • Voter Registration Referrals Block
    • Features
      • Affiliate Opt In
      • Affiliate Scholarship Block
      • Analytics Waypoint
      • Delayed Element
      • Dismissable Element
      • Stat Card
      • General Buttons
      • Groups
      • Paginated Campaign Gallery
      • Popover Dispatcher
      • Refer A Friend
      • Referrals Gallery
      • Sitewide Banner
      • Sixpack A/B Testing
        • Code Tests
        • Contentful Tests
        • Testing Tips
      • Tooltip
      • Traffic Distribution
      • Volunteer Credits
      • Voter Registration
      • Zendesk Form
    • Contentful
      • Workflow
      • Content Management API Scripts
    • Helpers
  • Phoenix API
    • v2
      • Campaigns Resource
      • Posts Resource
      • Zendesk Endpoint
  • Data + Performance
    • Monitoring
    • Analytics
    • Logging
  • Contributing Instructions
    • Edit This Documentation
    • Glossary
Powered by GitBook
On this page
  • .ENV (noun: /Dot EE EN VEE/)
  • Setup
  1. Installation + Usage

Installation

PreviousPrerequisitesNextUsage

Last updated 5 years ago

.ENV (noun: /Dot EE EN VEE/)

The .env file provides environment specific configurations that can be set differently depending on the environment (local, dev, qa, production, etc). Here is what an looks like from the Phoenix repository.

When running the Phoenix setup command (as specified below) from scratch, a copy of this .env.example file will be made and renamed to .env, and it will prompt you to enter some of the environment variable values gathered during the .

When the phoenix:setup command is run, some values will already be present as defaults based on the .env.example file.

You will need the following values on hand for the installation process:

  • Dev OAuth Client ID

  • Dev OAuth Client Secret

  • Contentful Space ID

  • Contentful API Key (recommended to use the Preview API Key)

Setup

Fork and clone the to your computer, and then installation.

With the above specified environment variable values on hand, start the Homestead Vagrant box, then ssh into it, and cd into the Phoenix repository location and run:

# Install dependencies:
$ composer install && npm install

# Configure application & run migrations:
$ php artisan phoenix:setup

# And finally, build the frontend assets:
$ npm start

Once the above commands finish executing, you should be able to go to http://phoenix.test in your browser and load the Phoenix platform! 🔥

example .env
prerequisites section
Phoenix repository
add it to your local Homestead