Skip to content

Arlind-dev/sulej.ch

Repository files navigation

sulej.ch

Welcome to the official repository of sulej.ch, my personal website.


πŸ“Œ Requirements

Ensure you have the following installed before running the project:

  • Node.js β†’ Version 20 LTS or higher
  • pnpm β†’ Version 9.12.2 or higher
  • Docker (Optional) β†’ Required if deploying via Docker

πŸš€ Usage

A pre-built, ready-to-use Docker image is available, supporting multiple CPU architectures:

  • x86 (amd64), ARM (arm64, arm/v7, arm/v6), RISC-V, PowerPC (ppc64le), IBM Z (s390x)

You can run it via Docker Compose or Docker Run. To use a previous version, specify a tag (e.g., :v0.1.0).

πŸ”Ή Docker Compose

services:
  sulej.ch:
    image: ghcr.io/arlind-dev/sulej.ch:latest
    container_name: sulej.ch
    restart: unless-stopped
    ports:
      - 8080:80
    networks:
      - sulej.ch

networks:
  sulej.ch:
    name: sulej.ch

πŸ”Ή Docker Run

docker run -d \
  --name sulej.ch \
  --restart unless-stopped \
  -p 8080:80 \
  ghcr.io/arlind-dev/sulej.ch:latest

πŸ“Œ Accessing Pinned GitHub Repositories

This project uses gh-pinned-repos to scrape pinned repositories (only works with public profiles).

To modify the repository link, edit:

πŸ“‚ /src/components/organisms/Repos.svelte


πŸ›  Running the Project

To run the project locally, follow these steps:

1️⃣ Clone the repository

git clone https://github.com/Arlind-dev/sulej.ch.git

2️⃣ Install dependencies

pnpm install

3️⃣ Start the development server

pnpm run dev

4️⃣ Access the application

  • Open: http://localhost:5173

πŸ“¦ Building the Project

1️⃣ Generate a production build

pnpm run build
  • The optimized build files will be stored in the /build directory.

2️⃣ Test the production build

pnpm run preview

3️⃣ Access the application

  • Open: http://localhost:4173

🚒 Deploying the Project

You can deploy this project using Docker or Cloudflare Pages & Workers.


🐳 Deploying with Docker

πŸ”Ή Steps

1️⃣ Fork the repository

  • Fork this repository to your GitHub account.
  • Enable GitHub Actions.

2️⃣ Add GitHub Repository Secrets and Variables

  • Navigate to GitHub β†’ Settings β†’ Secrets and Variables β†’ Actions.
  • Add the following secrets:
Name Description
GH_TOKEN Your GitHub token (read/write permissions)
GH_USERNAME Your GitHub username
  • Add the following repository variable:
Name Description
IMAGE_NAME Your desired Docker image name (sulej.ch)

3️⃣ Tag a New Release

git tag vX.X.X

(Replace vX.X.X with the actual version number.)

4️⃣ Push the Tag to GitHub

git push --tags
  • This triggers GitHub Actions to build & push the Docker image.

☁ Deploying to Cloudflare Pages

πŸ”Ή Steps

1️⃣ Fork the Repository

  • Fork this repository to your GitHub account.

2️⃣ Create a Cloudflare Worker & Pages Project

  • Log in to Cloudflare.
  • Create a new Pages project and connect it to your forked GitHub repository.

3️⃣ Set Environment Variables

  • In Cloudflare Pages β†’ Settings β†’ Environment Variables, add:
Variable Value
NODE_VERSION 20

4️⃣ Configure Build Settings

  • In Build & Deploy settings:
Setting Value
Framework preset None
Build command pnpm install && pnpm run build
Output directory /build

5️⃣ Deploy

  • Once connected, Cloudflare will automatically deploy the latest changes.

πŸ’‘ Contributions

Contributions are welcome! πŸš€

  • If you find bugs, submit an issue or create a pull request.
  • Feel free to fork this repository and modify it to fit your needs.
  • If you do, please credit the original repository: xafn/afn.im

πŸŽ‰ Contributors

Shoutout to everyone contributing to this project!

Contributor Versions Contributed
@MaximilianKos v0.2.0, v0.4.0

About

Official repository for the Sulej.ch website, built using SvelteKit.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •