go2 is a simpler URL shortener and redirection service for creating short links. It's a successor to uwcs-go, designed to be more streamlined.
go2 is written in Rust.
axumis used as an http framework, build on top of tokio and hypersqlxis used for database queriesaskamais used as a templating engine for the web interfacetailwindis used for styling
htmxis used to provide a little reactivity on the frontend
cargo run to build and start the server
go2 will attempt to read from the environment variables listed in .env.example to establish a database connection, both at compile time (for sqlx) and when running. Be sure to configure your development environment with those variables before running, which can be done by coping .env.example to .env and providing appropriate values.
A compose stack is provided to start go2, with both a supporting database container and a mock authentication service.
The stack uses host networking due to weirdness in communication between the user, go2, and the auth service. This means that stack requires rootful docker running on Linux, and will not work with rootless docker or on MacOS/Windows. Contributions of a workaround to this would be appreciated.
Docker will expose go2 on port 8080 and the authentication service on port 8081. You need to be able to access both ports to succesfully log in. To authenticated against the mock server, use one of the user accounts listed here.
API access is controlled by a token which must be provided in an authorisation header as a bearer token. The token is read from an environment variable when starting the server, and this must be set and kept secret in production. A random API token is generated if one is not set, the value of which is logged. This should only be used for development purposes
sqlx is far too clever, and it's query macros connect to the database at compile time to verify that your SQL is correct. It reads the DATABASE_URL from .env to do this, so make sure this is set or you will get compile errors. The easiest way to do this is to develop using docker, as the compose stack will spin up a database for you.
Alternatively, the sqlx-data.json file contains info generated from the database against which queries can be checked. If updating the database schema or queries, ths must be regenerated. Install the sqlx cli and run cargo sqlx prepare to do this.
Migrations in /migrations are embedded in the binary and run on startup. New migrations will need to be added if you make any changes that affect the database schema. Make sure to regeneate the sqlx-data.json too.
Tailwind is used for styling the HTML pages that provide the web interface. Cargo will rebuild static/output.css as part of it's build step, facilitated by the inclusion of a build script. The tailwindcss CLI is therefore required to run build go2, see instructions on how to download it here, and place the executable either on path somewhere or in the project root.