aloisseckar / elrhistory

Website template/framework designed for photos/pictures and information about some historical topic (e.g. history of a town)

ELRHistory

Website designed for photos/pictures and information about random historical topic (e.g. history of a town).

Originally a new version of StaraKrc Python project, this time in Nuxt3. However, my current goal is to make it customizable for possible re-use for other city parts etc.

Tech stack

• Nuxt 3 framework + VueUse + nuxt/i18n
• Tailwind CSS
• Supabase DB
• Formkit
• Icons made possible by FortAwesome
• Test images by Unsplash
• Linting via Nuxt ESLint module
• Tests TODO

Setting up

Right now you can just clone the repo and follow Nuxt 3 deployment instructions.

Later I plan to optimize the project for Netlify auto-deployment via GitHub Actions.

Re-branding

Configuration

Some site-related values are defined as Nuxt 3 runtime config variables. To tailor them the to your needs, use .env file.

List of variables:

• NUXT_PUBLIC_LANG - locale for i18n messages (currently supported either en or cs)
• NUXT_PUBLIC_DEBUG - if true, exdented information and logs are available (not meant for production - defaults to false)
• NUXT_PUBLIC_WEB_TITLE - website name, displayed as page title in browser tab + H1 on index page + in footer
• NUXT_PUBLIC_WEB_ABOUT - website description, displayed on index page in the About section
• NUXT_PUBLIC_WEB_AUTHOR - website author/currator, displayed in the footer
• NUXT_PUBLIC_WEB_LINK - link to author's website, links from author's name in the footer (if not blank)

Database

All site-specific data are being stored in Supabase database. DB schema is described in db-init.sql file and some initial data are provided in db-mock.sql.

To connect the application to your own Supabase, you need to provide unique SUPABASE_URL and SUPABASE_KEY via .env file. The rest is automatic.

Text

Static texts are served via nuxt/i18n. Translation files are served from /assets/lang/ directory. Currently en and cs messages are available.

Form validation

To change the language used in form validation messages, change default locale in formkit.config.ts on line 7. You may also need to import the corresponding source from @formkit/i18n on line 2.

Images

Replace following images in /public directory with your own content.

List of customizable images:

• header.png - displayed in top page ribbon, set up to be 120px high, centered and repeating along x-axis
• favicon.png - favicon displayed in browser tab

CSS

TODO