Developer Guidelines

New Project Setup

Git Repository

Create a repository on the Zaengle organization on GitHub using the repo naming rules.

Example: zaengle/guidelines.zaengle.com

Update the .env.example file with values relevant to the project (database name, app url, our Slack webhook url, etc.)

Server

  1. Provision a new server on Forge. Use a kebab-cased version of the domain name for the droplet (example: zaengle-developer-docs)
  2. If using Envoyer for deployments, create a new site with root /current/public, otherwise set the root to /public
  3. We typically generate assets during the deployment process, so ensure Envoyer has the correct hooks set up or Forge has yarn/npm scripts established.
  4. If required for the application framework, start one or two queue workers: default
  5. Update the relevant .env variables. Don't forget to add the necessary service API keys later.

Database Naming

It should be clear what project and environment a database is for based on the name. Typically we prefer something along the lines of {project_name}_{?platform}_{environment}.

Bad:
app_db - Not descriptive of project, platform, or environment

Better:
zaengle_production - Still missing platform

Best:
zaengle_craft_local - Includes the project, platform, and environment

← Version Control →