foundation: project guide, tooling, design tokens, bilingual shell and routing contracts
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
81
README.md
81
README.md
@@ -1,59 +1,62 @@
|
||||
# Portfolio
|
||||
|
||||
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.0.5.
|
||||
Bilingual recruiter and B2B portfolio for Antonio Ledebuhr, a software and DevOps engineer. German is the default language at `/`. English is the full second version under `/en`.
|
||||
|
||||
## Development server
|
||||
This repository is the Angular 21 standalone, zoneless, SSR application that serves both locales from one build.
|
||||
|
||||
To start a local development server, run:
|
||||
## Prerequisites
|
||||
|
||||
- Node.js 22 or newer
|
||||
- npm 11 or newer (npm 12 prints an engine-compatibility warning on some Node 24 builds; that warning is not an error)
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
ng serve
|
||||
npm install
|
||||
```
|
||||
|
||||
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
|
||||
## Scripts
|
||||
|
||||
## Code scaffolding
|
||||
| Script | Description |
|
||||
| ----------------------------- | ------------------------------------------------------------------------- |
|
||||
| `npm start` | Start the Angular dev server. |
|
||||
| `npm run build` | Production build (default configuration), including SSR and prerendering. |
|
||||
| `npm run watch` | Development rebuild on change. |
|
||||
| `npm test` | Unit tests in watch mode. |
|
||||
| `npm run test:ci` | Unit tests once; exits when finished. |
|
||||
| `npm run lint` | Run ESLint. |
|
||||
| `npm run lint:fix` | Run ESLint with autofix. |
|
||||
| `npm run format` | Format the workspace with Prettier. |
|
||||
| `npm run format:check` | Check formatting without writing. |
|
||||
| `npm run serve:ssr` | Serve the production SSR bundle from `dist/`. |
|
||||
| `npm run serve:ssr:Portfolio` | Alias of `serve:ssr`. |
|
||||
| `npm run ci` | lint, format check, tests, then production build. |
|
||||
|
||||
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
||||
## Local SSR build
|
||||
|
||||
```bash
|
||||
ng generate component component-name
|
||||
npm run build
|
||||
npm run serve:ssr
|
||||
```
|
||||
|
||||
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
||||
The server listens on `http://localhost:4000` unless `PORT` is set. The CV is copied into the browser output at `/cv/CV.pdf`.
|
||||
|
||||
```bash
|
||||
ng generate --help
|
||||
## Project structure
|
||||
|
||||
```
|
||||
src/app/core/ Typed contracts: locale, routing, navigation, content, platform
|
||||
src/app/features/ One standalone page per route id
|
||||
src/app/shared/ Reusable UI primitives
|
||||
src/app/components/ Existing decorative widgets (skills, dot background)
|
||||
src/styles.scss Design tokens and global primitives
|
||||
src/_breakpoints.scss Breakpoint map and respond-to mixin
|
||||
public/ Static SVG assets
|
||||
```
|
||||
|
||||
## Building
|
||||
Design tokens live in `src/styles.scss` as CSS custom properties. Content contracts and the placeholder provider live in `src/app/core/content`. Route ids and locale path tables live in `src/app/core/routing`.
|
||||
|
||||
To build the project run:
|
||||
Contributor and agent conventions are in [AGENTS.md](./AGENTS.md).
|
||||
|
||||
```bash
|
||||
ng build
|
||||
```
|
||||
## Legal pages
|
||||
|
||||
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
|
||||
|
||||
## Running unit tests
|
||||
|
||||
To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
|
||||
|
||||
```bash
|
||||
ng test
|
||||
```
|
||||
|
||||
## Running end-to-end tests
|
||||
|
||||
For end-to-end (e2e) testing, run:
|
||||
|
||||
```bash
|
||||
ng e2e
|
||||
```
|
||||
|
||||
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|
||||
The Impressum (`/impressum`, `/en/legal-notice`) and Datenschutz (`/datenschutz`, `/en/privacy`) pages contain unreviewed placeholders. They must be checked by the site owner before publication.
|
||||
|
||||
Reference in New Issue
Block a user