This repository contains the code for the Web Gallery of Art project. The project is a web application that allows users to browse through a collection of paintings, sculptures and other forms of Art. This project is intended to shave off the 3 decades of tech debt on the original website and provide a modern, responsive and user friendly experience with the same content.
The project is built using the following technologies:
- htmx - A javascript library for building web applications
- TailwindCSS - A utility-first CSS framework
- DaisyUI - A component library for TailwindCSS
- Go 1.21+ - A programming language for building web applications
- PocketBase - A Go based SaaS platform for building web applications
- Goreleaser - A tool for building and releasing Go applications
To run the application you'll have to have a .env file next to your executable with the following contents:
WGA_ENV=development
WGA_ADMIN_EMAIL=
WGA_ADMIN_PASSWORD=
WGA_S3_ENDPOINT=
WGA_S3_BUCKET=
WGA_S3_REGION=
WGA_S3_ACCESS_KEY=
WGA_S3_ACCESS_SECRET=
WGA_PROTOCOL=http
WGA_HOSTNAME=localhost:8090
WGA_SMTP_HOST=
WGA_SMTP_PORT=
WGA_SMTP_USERNAME=
WGA_SMTP_PASSWORD=
WGA_SENDER_ADDRESS=
WGA_SENDER_NAME=
MAILPIT_URL=| Variable | Description |
|---|---|
WGA_ENV |
The environment the application is running in, valid values are development, staging, production |
WGA_ADMIN_EMAIL |
The email address of the admin user |
WGA_ADMIN_PASSWORD |
The password of the admin user |
WGA_S3_ENDPOINT |
The endpoint of the S3 bucket |
WGA_S3_BUCKET |
The name of the S3 bucket |
WGA_S3_REGION |
The region of the S3 bucket |
WGA_S3_ACCESS_KEY |
The access key of the S3 bucket |
WGA_S3_ACCESS_SECRET |
The access secret of the S3 bucket |
WGA_PROTOCOL |
The protocol to use for the application, valid values are http and https |
WGA_HOSTNAME |
The domain pointing to the application |
WGA_SMTP_HOST |
The address of the SMTP host |
WGA_SMTP_PORT |
The SMTP service port on the host address |
WGA_SMTP_USERNAME |
The username for the SMTP service |
WGA_SMTP_PASSWORD |
The password for the SMTP service |
WGA_SENDER_ADDRESS |
The sending email address |
WGA_SENDER_NAME |
The name of the email sender |
MAILPIT_URL |
For testing only! |
To run the application simply download the release for your platform and run it with:
./wga serveThe application will start on port 8090 by default. You can access it by going to http://localhost:8090
To build the application you will need to have the following installed:
- Go 1.21+
- Bun v1.1+
- Goreleaser
- Templ
To build the application simply run:
templ generate && go build -o wgaThis will build the application and place the binary in the ./dist folder.
Contributions are welcome. Please read CONTRIBUTING.md for more information.
The supplied docker-compose.yml file will bring up a configured minio and mailpit instance to simulate the services used in production.
All frontend assets (templ, postcss) can be built with bun run dev (this command will start a dev server as well) and the JS dependencies with bun run build:js.
The database is populated on first start, and if you want to have images available, make sure that your WGA_ENV=development is set and then you can execute:
./wga seed:imagesThis will go through the contents of the database and will use placeholder images to "generate" the necessary images to the designated S3 compatible file hosting solution designated in the .env file.
This project has a Nix flake.nix with the full development environment configuration in it. Start it with:
nix developIf you want to start the development environment automatically when entering the directory, install direnv and run direnv allow in this directory.
With Nix installed, you do not need to install Go, ASDF, node, npm, bun or other development tools. Nix package manager will handle it for you, and makes sure the versions are correct for this project. This has been tested on both Linux and macOS. Nix is a package manager for the whole system/development environment, not just 1 part of it, like NPM is for Node. There is also NixOS, which works in the same way but for the whole OS, making it declarative and versioned. The config in this project works for both. With the Nix Flake in this project, you are using Nix only to manage the development environment.
For both Linux and macOS, you can use the installer from determinate systems. On the site Zero to nix you can find more info to get started.
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- installIf you installed Nix differently, make sure that you enable flakes. Flake concepts explained. Flakes are experimental, but highly recommended and included with Nix for years.
This project is licensed under the MIT License - see the LICENSE.md file for details
