[Updated] Readme
This commit is contained in:
@@ -1,59 +1,40 @@
|
|||||||
# Portfolio
|
# Portfolio Website
|
||||||
|
|
||||||
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.0.
|
My portfolio website, used to display my projects.
|
||||||
|
|
||||||
## Development server
|
|
||||||
|
|
||||||
To start a local development server, run:
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
### Install Docker
|
||||||
|
- On Windows and Mac
|
||||||
|
```
|
||||||
|
Install Docker Desktop
|
||||||
|
Windows: https://docs.docker.com/desktop/install/windows-install/
|
||||||
|
Mac: https://docs.docker.com/desktop/install/mac-install/
|
||||||
|
```
|
||||||
|
- On Linux
|
||||||
```bash
|
```bash
|
||||||
ng serve
|
# For Debian-based systems
|
||||||
|
sudo apt install -y docker.io
|
||||||
|
sudo apt install docker-compose
|
||||||
|
|
||||||
|
#For Arch-based systems
|
||||||
|
sudo pacman -S docker.io
|
||||||
|
sudo pacman -S docker-compose
|
||||||
|
|
||||||
|
# Making Docker run now and on startup
|
||||||
|
sudo systemctl start docker
|
||||||
|
sudo systemctl enable docker
|
||||||
|
|
||||||
|
# Using the CLI without sudo
|
||||||
|
sudo usermod -aG docker $USER
|
||||||
|
sudo reboot
|
||||||
```
|
```
|
||||||
|
|
||||||
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.
|
## How to run
|
||||||
|
- Navigate to the root of the project
|
||||||
## Code scaffolding
|
- Open a terminal
|
||||||
|
- Start the containers:
|
||||||
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ng generate component component-name
|
docker compose up
|
||||||
```
|
```
|
||||||
|
- Visit localhost:4400 to visit the website locally
|
||||||
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
- Or visit https://www.ianvink.nl to find the live version!
|
||||||
|
|
||||||
```bash
|
|
||||||
ng generate --help
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
To build the project run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ng build
|
|
||||||
```
|
|
||||||
|
|
||||||
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 [Karma](https://karma-runner.github.io) 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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user