README.md

😎 a Fantasitc developer profile website using GitHub pages, SvelteJS, VisJS and Tailwind CSS.

See the live 🌐 website.

🤖 Installation

1. Prepare your config.json change the information according to your credentials.
2. Rename .env-sample to .env and fill in your environment variable (GitHub Tokens)

🌐 via any local Web Server

1. Install node package npm install
2. Generate nodes.json and edges.json by running node generator.js
3. Then open it :
   • PHP Server : php -S 127.0.0.1:80
   • XAMPP, LAMP, MAMP, WAMP Server
   • Nginx, Apache
   • etc

🐳 via Docker Compose

• Run docker-compose up -d --build

🐳 via Docker Run

1. Generate nodes.json and edges.json

docker run -d -p 80:80 \
  --name agung2001.github.io \
  -v /path/to/.env:/usr/share/nginx/html/.env \
  -v /path/to/config.json:/usr/share/nginx/html/config.json \
  -v /path/to/nodes.json:/usr/share/nginx/html/nodes.json \
  -v /path/to/edges.json:/usr/share/nginx/html/edges.json \
  agung2001/agung2001.github.io:latest

2. Run as daemon service

docker run -d -p 80:80 \
  --name agung2001.github.io \
  -v /path/to/.env:/usr/share/nginx/html/.env \
  -v /path/to/config.json:/usr/share/nginx/html/config.json \
  -v /path/to/avatar.jpg:/usr/share/nginx/html/assets/img/avatar.jpg \
  -v /path/to/cover.jpg:/usr/share/nginx/html/assets/img/cover.jpg \
  -v /path/to/nodes.json:/usr/share/nginx/html/nodes.json \
  -v /path/to/edges.json:/usr/share/nginx/html/edges.json \
  agung2001/agung2001.github.io:latest

• NOTE: Don't forget to change the /path/to/ accordingly

📝 Notes

Conventional Commits

• This project uses Conventional Commits to create a clean commit.
• If one of your commit is failing please try committing by using this type of commit message :
  • feat: creating awesome feature for this repo

Distro

I made DISTRO to list a profile and customization you made to this repo.

Google Analytics

To easily track visitors I use Google Analytics and put the code inside index.html. You can change the code with your own, if you also want to track the visitors coming to the website.

How to Generate GitHub Tokens

• Please refer to GitHub Docs - Creating a personal access token to create personal access token.
• Please set the expiration to no expiration and enable : Repo and User

Live Reload

This repo comes with livereload module, to learn more please goto gruntjs/grunt-contrib-watch

📚 Resources

• 🌟 Official Repo
• Conventional Commits
• Docker Hub
• GHCR
• GitHub REST API Docs

⚒️ Built with

• Animate.style
• Commitlint
• Dotenv
• EditorConfig
• Eslint
• Fontawesome
• GitHub Action
  • docker/build-push-action
  • JamesIves/github-pages-deploy-action
• Grunt JS
• Husky
• Octokit.js
• Prettier
• Svelte JS
• Release-It
  • Bumper
  • Conventional Changelog
• TailwindCSS
• Vis JS

⭐️ Support & Contribution

• Help support me by giving a 🌟 or donate
• Please refer to CONTRIBUTING to see a way to contribute to this repo