badmanners/gallery.badmanners.xyz
badmanners/gallery.badmanners.xyz
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
gallery.badmanners.xyz/README.md

1.2 KiB
Raw Blame History

gallery.badmanners.xyz

Static website built in Astro + Typescript + TailwindCSS.

Requirements

  • Node.js 20+
  • (optional) LFTP, for the remote deployment script.
  • (optional) LibreOffice, for the story export script.

Development

Setup

git clone https://git.badmanners.xyz/badmanners/gallery.badmanners.xyz
cd gallery.badmanners.xyz
npm install && npm run sync

Local development

npm run dev       # Start development server (quit with Ctrl-C)
npm run sync      # Rebuild types from src/content/ files
npm run prettier  # Prettier formatting

Export story for upload

Requires libreoffice to be installed and in your path.

npm run export-story -- --output-dir ~/Documents/TO_UPLOAD slug-for-story-to-export

Build and deploy to remote

npm run build

Then, if you're using LFTP:

  1. Create a new .env file at the root of the project with your credentials (SSH, SFTP, WebDav, etc.) if you haven't already:
DEPLOY_LFTP_HOST=https://example-webdav-server.com
DEPLOY_LFTP_USER=example_user
DEPLOY_LFTP_PASSWORD=sup3r_s3cr3t_password
DEPLOY_LFTP_TARGETFOLDER=sites/gallery.badmanners.xyz/
  1. Run the deploy command:
npm run deploy-lftp