Skip to content

JeanFranz73/wallpapers

Repository files navigation

wallpapers

simple wallpaper website made with vue, tailwindcss and headlessui, with a lowercase prompt-like style.

add your wallpaper

installation

adding wallpapers

if you want to send a wallpaper, you can do so by creating a pull request with the wallpaper added to the public/images/ folder and the metadata added to the public/wallpapers.json file following the format below:

{
  "title": "title", // the title of the wallpaper
  "author": "author", // or unkown
  "filename": "wallpaper.png", // the filename of the wallpaper
  "categories": ["category1", "category2"] // the categories of the wallpaper
}

you can add multiple categories to the wallpaper, and the current available categories are:

  • fantasy
  • scifi

project setup

this project uses bun instead of node, primarily because of the speed and I wanted to try new technologies.

with docker

this project has a docker compose file, so you can run it with docker.

docker compose up -d

to stop the project, run:

docker compose down

manually

if you want to run it manually, you can do so by installing bun first.

To install bun, run the following command:

# for unix:
curl -fsSL https://bun.sh/install | bash

# for windows:
powershell -c "irm bun.sh/install.ps1 | iex"

then, to install the dependencies, run:

bun install

and to execute the project, run:

bun dev

the project will be available at http://localhost:5173/wallpapers/.