An open API service indexing awesome lists of open source software.

https://github.com/pumukydev/pumukydev.com

A self-updating portfolio powered by Flask and HTMX, including a whoami section, experience timeline, and a dynamic list of top-ranked GitHub project
https://github.com/pumukydev/pumukydev.com

css docker flask htmx personal-site portfolio python

Last synced: 3 months ago
JSON representation

A self-updating portfolio powered by Flask and HTMX, including a whoami section, experience timeline, and a dynamic list of top-ranked GitHub project

Awesome Lists containing this project

README

          

# pumukydev.com


portfolio preview

## πŸ“¦ Requirements

- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

## πŸ› οΈ Setup Instructions

### 1. Clone the repository

```bash
git clone https://github.com/PumukyDev/pumukydev.com.git
cd pumukydev.com
```

### 2. Configure the web

1. Copy the environment file:

```bash
cp ./app/.env.example ./app/.env
```

2. Edit the `.env` file:

- Add your **GitHub token** (you can generate one [here](https://github.com/settings/tokens)). It only needs `public_repo` permissions.
- Add your **GitHub username**.

3. Replace the content in `/app/templates/index.html` and `/app/data/experience.json` to reflect your own professional experience and personal info.

4. To exclude any of your repositories from being shown, list their names in `/app/blacklist.txt`.

### 3. Deploy the server

```bash
docker-compose up -d --build
```

### 4. See the web

Visit [http://localhost:8000](http://localhost:8000)

If you want to deploy it publicly, check this guide where I explain how to self-host it:
πŸ‘‰ [https://github.com/PumukyDev/self-hosting](https://github.com/PumukyDev/self-hosting)

## πŸ” Fork this project

If this template was useful to you:

- Fork it and make it your own
- Replace the content with your personal data
- Don’t forget to **mention** `@PumukyDev` if you use or get inspired by it β€” I’d love to see your version!
- Contributions and stars are always welcome 🀍

## πŸ“„ License

This project is open-source and available under the [MIT License](LICENSE).