|
1 | 1 | # Portfolio
|
2 | 2 |
|
3 |
| -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.2.0. |
| 3 | +This repo relies on |
| 4 | +- [androids repo tool for pulling in external code dependencies through Git](https://source.android.com/docs/setup/reference/repo#init) |
| 5 | +- Docker for running the [Dockerfile](./.devcontainer/docker/Dockerfile) and the [dev container](./.devcontainer/devcontainer.json) |
| 6 | +- VS Code for running docker through the [dev container](./.devcontainer/devcontainer.json). The [dev container](./.devcontainer/devcontainer.json) is responsible for setting up a `.env` file that contains environment variables that provides the following to the container |
| 7 | + - Git user info |
| 8 | + - Git SSH public and private keys |
4 | 9 |
|
5 |
| -## Development server |
| 10 | +## Prerequisites |
6 | 11 |
|
7 |
| -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. |
| 12 | +1. Open the project in the docker container through VS Code or dockers CLI. |
| 13 | +> Note: If running the container purely through docker, Git credentials may have to be setup manually |
| 14 | +2. First time setup of the `repo` tool and dependent repositories |
8 | 15 |
|
9 |
| -## Code scaffolding |
| 16 | +```bash |
| 17 | +repo init -u "https://github.com/Xerner/manifests" -b "development" -m "xerner.github.io.default.xml" |
| 18 | +repo sync |
| 19 | +``` |
10 | 20 |
|
11 |
| -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. |
| 21 | +## Building The App |
12 | 22 |
|
13 |
| -## Build |
| 23 | +1. Follow the [prerequisite steps](#prerequisites) |
| 24 | +2. Build the app with `ng build` |
14 | 25 |
|
15 |
| -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. |
| 26 | +## Serving The App |
16 | 27 |
|
17 |
| -## Running unit tests |
18 |
| - |
19 |
| -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). |
20 |
| - |
21 |
| -## Running end-to-end tests |
22 |
| - |
23 |
| -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. |
24 |
| - |
25 |
| -## Further help |
26 |
| - |
27 |
| -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. |
| 28 | +1. Follow the [prerequisite steps](#prerequisites) |
| 29 | +2. Serve the app with `ng serve --configuration development` |
0 commit comments