Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sashuu69 authored May 29, 2024
1 parent 6bb95e6 commit 70c25c0
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Introduction

The Portfolio Website is a Python Flask application to host your personal portfolio.
The Portfolio Website is a Python Flask application to host your portfolio.

## Technologies Used

Expand All @@ -16,7 +16,7 @@ The Portfolio Website is a Python Flask application to host your personal portfo

## Update Content.

* Update `data/index.json` to update website's content.
* Update `data/index.json` to update the website's content.
* Update `static/images/profile_photo/me.jpg` and `static/images/profile_photo/favicon.png` with desired profile photo and favicon.
* Add skills photos under `static/images/skills`.
* Add testimonial profile photos under `static/images/testimonials`.
Expand All @@ -25,19 +25,19 @@ The Portfolio Website is a Python Flask application to host your personal portfo
## Development Setup

1. Make sure `python3`, `pip3` and `virtualenv` is installed on the development setup.
2. Create python virtual environment using the command.
2. Create Python virtual environment using the command.
```bash
virtualenv portfolio_env
```
3. Active the virtual environment using the command.
```bash
source portfolio_env/bin/activate
```
4. Install necessary python packages using the command.
4. Install necessary Python packages using the command.
```bash
pip3 install -r requirements.txt
```
5. To run and debug the flask app, run the command.
5. To run and debug the Flask app, run the command.
```bash
python3 debug.py
```
Expand All @@ -52,6 +52,11 @@ The Portfolio Website is a Python Flask application to host your personal portfo

## Other Info

If you face any bugs or want to request for a new feature, please create an issue under the repository and provide appropriate labels respectively. If you want to do these by yourself, feel free to raise a PR and I will do the necessary.
If you face any bugs or want to request a new feature, please create an issue under the repository and provide appropriate labels respectively. If you want to do these by yourself, feel free to raise a PR and I will do what is necessary.

If you want to support me, donations will be helpful.

## Other Repos

1. [sashuu69/portfolio-website-docker-compose](https://github.com/sashuu69/portfolio-website-docker-compose) - The docker-compose code to bring up portfolio website
2. [sashuu69/portfolio-website-infrastructure/](https://github.com/sashuu69/portfolio-website-infrastructure) - The terraform and ansible code to bring portfolio website on AWS

0 comments on commit 70c25c0

Please sign in to comment.