Introduction
What EEP is, why this template exists, and what you will find in these docs.
👋 Hey there!
Welcome, and thank you for taking the time to explore the Engineering Enablement Platform (EEP), a suite of tools designed to help people learn and build software projects in a repeatable, standardised, and structured way.
As agentic engineering becomes more prevalent our abstractions become higher. When we work on projects now rather than holding every feature implementation in our heads, we operate more like architects. But that only works when the foundations are solid. The goal should be a codebase you can always navigate by its shape, not by having to read everything. This template and accompanying documentation is built to give you exactly that!
There are many different ways to approach software projects and nothing here represents a hard rule or the only "right" way to do something. Feel free to pick and chose from the ideas and conventions listed as you see fit.
I'd also highly encourage trying the scaffolding exercise yourself, it's a fantastic learning tool and great way to find out exactly what does and doesn't work for you.
Have fun learning & building!
What you will find here
- Tools & Technologies covers every technology in the template and why it is here
- Architecture explains the three-layer system and how a request moves through it
- Conventions covers coding standards, naming rules, and testing approach
- Dev Environment covers local setup, the dev container, auth, and the database