⏩Quickstart

Getting started with Fast Phoenix is as easy as 1, 2, 3! Follow these three steps to kick off your next Phoenix project:

Let's get started!

1. Purchase and Download Purchase the Fast Phoenix template and download the provided ZIP file to your local machine.

2. Extract the Template Unzip the downloaded file to your desired project directory.

3. Install Dependencies & setup Open your terminal, navigate to the project directory, and run:

mix deps.get
docker run --name phx_saas_db -p 5432:5432 -e POSTGRES_USER=phxsaas -e POSTGRES_PASSWORD=phxsaas -e POSTGRES_DB=phx_saas_db -d postgres
mix ecto.setup
cd assets
npm install
cd ..
mix phx.server

Fast Phoenix has streamlined the setup process, so you can focus on what matters—building your application. 🚀

Setup

Fast Phoenix includes an .env file to streamline your configuration for development. This file stores critical environment variables for services like Stripe, Mailgun, and project-specific constants.

Configure Development Environment Variables

Located in envs/ directory, You'll find an.env.dev file. These files contain predefined variables for development environments.

Open .env.dev and in a text editor, and replace the placeholder values with your own details. Here's what you'll need to customize:

SAAS_NAME=FastPhoenix
DOMAIN=your-domain.com 
EMAIL=[e-mail] 
LOGO_LOCATION="your-logo-url"

# Stripe Configuration
STRIPE_API_KEY=your-stripe-api-key
STRIPE_SIGNING_SECRET=your-signing-secret
STRIPE_API_BASE_URL=http://localhost:4000
STRIPE_PRO_PRICE_ID=your-pro-price-id
STRIPE_PRO_PRICE=30
STRIPE_ENTERPRISE_PRICE_ID=your-enterprise-price-id
STRIPE_ENTERPRISE_PRICE=100
STRIPE_PORTAL_ID=your-portal-id

# Mailgun Configuration
MAILGUN_API_KEY=your-mailgun-api-key
MAILGUN_DOMAIN=your-mailgun-domain

You’re all set! With the .env files configured, Fast Phoenix is ready to handle your environment-specific settings for development seamlessly.