ulith/pronounss
1
0
Fork 0
forked from mirrors/pronouns.cc
Code Pull requests Activity
Website to share your preferred names and pronouns
58 commits 17 branches 30 tags 2.1 MiB
Go 57.2%
Svelte 31.1%
TypeScript 10.2%
Rust 0.5%
HTML 0.3%
Other 0.6%
Find a file
Sam 1c8276188c feat: seeddb script
2022-11-20 03:11:01 +01:00
backend fix(backend): actually resize avatars on upload 2022-11-20 01:54:47 +01:00
frontend fix(frontend): fix discord login page 2022-11-20 01:24:36 +01:00
scripts feat: seeddb script 2022-11-20 03:11:01 +01:00
.gitignore don't serve frontend from api server anymore 2022-07-11 22:35:20 +02:00
.prettierrc add frontend template + GET /users/{userRef} route 2022-05-04 16:27:16 +02:00
go.mod feat(backend): some member routes, half-broken avatar uploading 2022-09-20 12:55:00 +02:00
go.sum feat(backend): some member routes, half-broken avatar uploading 2022-09-20 12:55:00 +02:00
LICENSE initial commit 2022-05-02 17:19:37 +02:00
Makefile feat: seeddb script 2022-11-20 03:11:01 +01:00
README.md feat(api): add POST /members 2022-10-03 10:59:30 +02:00

README.md

pronouns.cc

A work-in-progress site to share your names, pronouns, and other preferred terms.

Stack

  • API server is written in Go with the chi router
  • Persistent data is stored in PostgreSQL
  • Temporary data is stored in Redis
  • The frontend is written in TypeScript with React, using Next for server-side rendering
  • Avatars are stored in S3-compatible storage (MinIO for development)

Development

When working on the frontend, run the API and then use yarn dev in frontend/ for hot reloading.

Building

Run make backend to build the API server, then run yarn build in frontend/.

Running

Both the backend and frontend are expected to run behind a reverse proxy such as Caddy.

The frontend should serve every possible path except anything starting with /api/, which should be routed to the backend instead. Make sure to rewrite requests going to the API server to remove the starting /api/.

License

Copyright (C) 2022  Sam <u1f320>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.