diff --git a/README.md b/README.md index cf68d7d..58a078b 100644 --- a/README.md +++ b/README.md @@ -39,14 +39,21 @@ You will be prompted to choose a project name, your preferred frontend, and back - Flask (v3.1.3) - .NET (v10.0.11) - Node.js Express (v5.2.1) -- **Database**: PostgreSQL (v15) with Alembic (v1.19.1), SQLAlchemy (v2.0.52), and Psycopg2 (v2.9.12). +- **Database**: PostgreSQL (v15) configured via `docker-compose`. Tooling includes: + - **Migrations**: Alembic (v1.19.1), SQLAlchemy (v2.0.52), and Psycopg2 (v2.9.12) are used universally for database migrations across all frameworks. + - **Drivers**: FastAPI/Flask use SQLAlchemy/Psycopg2, Node.js Express uses `pg` (v8.23.0), and .NET uses `Npgsql` (v10.0.3). - **Opinionated Defaults**: We bake in sensible, predefined choices (e.g., Angular uses `zone.js`, testing is unified under Playwright and framework-native test runners). - **Unified Scripts**: `start.sh`, `test.sh`, and `lint.sh` available out of the box to manage both frontend and backend seamlessly. - **CI/CD Ready**: Includes a pre-configured `.github/workflows/cli-e2e.yml` that tests both ends. _Tip: To enforce this, enable branch protection in your GitHub repository settings and require the "test" status check to pass._ - **Developer Experience**: Includes `.vscode/extensions.json` recommending the necessary linters and formatters, and an `AGENTS.md` file providing behavioral guidelines for AI agents. It is AI development friendly, including an extensive set of agent skills in `.agents/skills`.
Included Agent Skills -

senior-frontend, senior-qa, senior-fullstack, accessibility-general

+
## Generated Project @@ -109,6 +116,12 @@ This project redistributes boilerplate code and configuration files generated by - [Flask](https://flask.palletsprojects.com/) (BSD 3-Clause License) - [.NET](https://dotnet.microsoft.com/) (MIT License) - [Express](https://expressjs.com/) (MIT License) +- [PostgreSQL](https://www.postgresql.org/) (PostgreSQL License) +- [Alembic](https://alembic.sqlalchemy.org/) (MIT License) +- [SQLAlchemy](https://www.sqlalchemy.org/) (MIT License) +- [Psycopg2](https://www.psycopg.org/) (LGPL with exceptions) +- [node-postgres (pg)](https://node-postgres.com/) (MIT License) +- [Npgsql](https://www.npgsql.org/) (PostgreSQL License) ## References diff --git a/templates/base/README.md b/templates/base/README.md index f4d0c5d..543b13a 100644 --- a/templates/base/README.md +++ b/templates/base/README.md @@ -24,7 +24,7 @@ To start the database, backend, and frontend development servers, simply run: ./start.sh ``` -**Database Note:** The `start.sh` script will automatically spin up a **PostgreSQL (v15)** database using Docker Compose, and it will run **Alembic (v1.16.5)** (using SQLAlchemy v2.0.52 and Psycopg2 v2.9.12) to handle migrations before starting the rest of your app. +**Database Note:** The `start.sh` script will automatically spin up a **PostgreSQL (v15)** database using Docker Compose, and it will run **Alembic (v1.19.1)** (using SQLAlchemy v2.0.52 and Psycopg2 v2.9.12) to handle migrations before starting the rest of your app. ### Testing and Linting @@ -47,5 +47,10 @@ This repository is optimized for development with AI agents:
Included Agent Skills -

senior-frontend, senior-qa, senior-fullstack, accessibility-general

+