[Updated] Readme

This commit is contained in:
Ninjaws
2024-11-24 19:05:35 +01:00
parent 5db3bf71a9
commit 283f197e36
+33 -52
View File
@@ -1,59 +1,40 @@
# Portfolio
# Portfolio Website
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.0.
## Development server
To start a local development server, run:
My portfolio website, used to display my projects.
## 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
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.
## Code scaffolding
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
## How to run
- Navigate to the root of the project
- Open a terminal
- Start the containers:
```bash
ng generate component component-name
docker compose up
```
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
```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.
- Visit localhost:4400 to visit the website locally
- Or visit https://www.ianvink.nl to find the live version!