Skip to content

funamitech/mirror

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

30 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

YuruMirror (Modern!)

Mirror project with modern TailwindCSS design. Docker files provided for testing.

src/ contains the website files with modern styling and directory listing functionality.

πŸš€ Tech Stack

  • Tailwind CSS 4.1 (CSS-first configuration)
  • Tailwind CLI (@tailwindcss/cli)
  • Vanilla HTML/JS

🚧 Requirements

  • Node.js 20+ (Tailwind v4 requires modern Node and browsers)
  • npm

🧰 Install

npm install

πŸ”¨ Build CSS

  • Production:

    npm run build-css-prod

    Outputs src/assets/css/tailwind.css (minified)

  • Development (watch):

    npm run build-css

πŸ“ Project Structure

mirror/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/
β”‚   β”‚   β”œβ”€β”€ css/
β”‚   β”‚   β”‚   β”œβ”€β”€ input.css      # Tailwind v4 entry + @theme, @utility
β”‚   β”‚   β”‚   └── tailwind.css   # Generated CSS (after build)
β”‚   β”‚   β”œβ”€β”€ js/
β”‚   β”‚   └── img/
β”‚   β”œβ”€β”€ theme/
β”‚   β”œβ”€β”€ error/
β”‚   └── *.html
β”œβ”€β”€ package.json
└── README.md

🚒 Deployment

  1. Build CSS:
    npm run build-css-prod
  2. Deploy the src/ directory to your web server. Ensure src/assets/css/tailwind.css is included.

πŸ› οΈ Scripts

  • npm run build-css-prod β€” Build minified CSS for production
  • npm run build-css β€” Watch and rebuild CSS on changes
  • npm run lint β€” ESLint for JS
  • npm run lint:fix β€” ESLint with auto-fix

🐳 Docker

Docker files are provided for testing and deployment:

sudo docker compose up --build -d

About

Source code of funami.tech's YuruMirror

Resources

License

Stars

Watchers

Forks