The website for the Handmade Network and associated projects. https://handmade.network/

Go to file

bvisness 0210a0784b Add Discord login (#106 ) This leverages our existing Discord OAuth implementation. Any users with a linked Discord account will be able to log in immediately. When logging in, we request the `email` scope in addition to `identity`, so existing users will be prompted one time to accept the new permissions. On subsequent logins, Discord will skip the prompt. When linking your Discord account to an existing HMN account, we continue to only request the `identity` scope, so we do not receive the user's Discord email. Both login and linking go through the same Discord OAuth callback. All flows through the callback try to achieve the same end goal: a logged-in HMN user with a linked Discord account. Linking works the same as it ever has. Login, however, is different because we do not have a session ID to use as the OAuth state. To account for this, I have added a `pending_login` table that stores a secure unique ID and the eventual destination URL. These pending logins expire after 10 minutes. When we receive the OAuth callback, we look up the pending login by the OAuth `state` and immediately delete it. The destination URL will be used to redirect the user to the right place. If we have a `discord_user` entry for the OAuth'd Discord user, we immediately log the user into the associated HMN account. This is the typical login case. If we do not have a `discord_user`, but there is exactly one HMN user with the same email address as the Discord user, we will link the two accounts and log into the HMN account. (It is possible for multiple HMN accounts to have the same email, because we don't have a uniqueness constraint there. We fail the login in this case rather than link to the wrong account.) Finally, if no associated HMN user exists, a new one will be created. It will use the Discord user's username, email, and avatar. This user will have no password, but they can set or reset a password through the usual flows. Co-authored-by: Ben Visness <bvisness@gmail.com> Reviewed-on: #106		2023-05-06 19:38:50 +00:00
adminmailer	Changed adminmailer to read the message from stdin	2021-09-02 00:08:08 +03:00
cinera	Always update snippet tags on every Discord edit	2021-12-08 23:00:44 -06:00
fishbowl-tools	Add fishbowl tools (#64 )	2022-07-16 09:02:29 -05:00
local	Delete resetdb.sh	2022-05-16 10:26:56 -05:00
public	Add Discord login (#106 )	2023-05-06 19:38:50 +00:00
server	Edit scripts too, oops	2022-07-22 20:56:16 -05:00
src	Add Discord login (#106 )	2023-05-06 19:38:50 +00:00
.gitignore	Ignore session and tags files	2023-01-16 22:12:12 -05:00
README.md	Update README to warn about wellington problems	2023-04-08 11:49:48 -05:00
go.mod	Add handmade cities banner v1	2023-03-24 17:38:24 -04:00
go.sum	Add handmade cities banner v1	2023-03-24 17:38:24 -04:00
main.go	Move main.go to the root so we can do `go run .`	2022-07-22 20:52:06 -05:00

README.md

Handmade Network

This is the codebase for the Handmade Network website, located online at https://handmade.network. The website is the home for all Handmade projects, the forums, the podcast, and other various initiatives.

The site is written in Go, and uses the standard library HTTP server with custom utilities for routing and middleware. It uses Postgres for its database, making heavy use of the excellent pgx library along with some custom wrappers. See the documentation in the db package for more details.

We want the website to be a great example of Handmade software on the web. We encourage you to read through the source, run it yourself, and learn from how we work. If you have questions about the code, or you're interested in contributing directly, reach out to us in #network-meta on the Handmade Network Discord!

Prerequisites

You will need the following software installed:

Go 1.18 or 1.19: https://go.dev/

You can download Go directly from the website, or install it through major package managers. If you already have Go installed, but are unsure of the version, you can check by running go version.

PLEASE NOTE: Go 1.20 currently does not work due to a bug in a third-party library. See this issue.
Postgres: https://www.postgresql.org/

Any Postgres installation should work fine, although less common distributions may not work as nicely with our scripts out of the box. On Mac, Postgres.app is recommended.

First-time setup

Configure the site. Copy src/config/config.go.example to src/config/config.go:
```
# On Windows
copy src\config\config.go.example src\config\config.go

# On Mac and Linux
cp src/config/config.go.example src/config/config.go
```
Depending on your installation of Postgres, you may need to modify the hostname and port in the Postgres section of the config.
Set up the database. Run go run . db seed to initialize the database and fill it with sample data.
Update your hosts file. The website uses subdomains for official projects, so the site cannot simply be run off localhost. Add the following line to your hosts file:
```
127.0.0.1 handmade.local hero.handmade.local 4coder.handmade.local
```
You may need to edit the hosts file again in the future if you add more official projects.

On Windows, the hosts file is located at C:\Windows\System32\Drivers\etc\hosts. On Mac and Linux, the hosts file should be located at /etc/hosts. It can be edited using any plain text editor, but you will need superuser permissions.

Running the site

Running the site is easy:

go run .

You should now be able to visit http://handmade.local:9001 to see the website!

There are also several other commands built into the website executable. You can see documentation for each of them by running go run . help or adding the -h flag to any command.

Running tests

Also easy:

go test ./...

Note that we have a special coverage requirement for the hmnurl package. We use the tests in this package to ensure that our URL builder functions never go out of sync with the regexes used for routing. As a result, we mandate 100% coverage for all Build functions in hmnurl.

Starter data

The db seed command pre-populates the site with realistic data. It also includes several user accounts that you may log into to test various situations:

Username	Password
`admin`	`password`
`alice`	`password`
`bob`	`password`
`charlie`	`password`

The admin user is a superuser on the site and will have access to all features, as well as the special admin UI for performing site maintenance and moderation. The other users are all normal users.