2022-06-06 06:32:10 -07:00
|
|
|
# pronouns.cc
|
2022-05-02 08:19:37 -07:00
|
|
|
|
2022-10-03 01:59:30 -07:00
|
|
|
A work-in-progress site to share your names, pronouns, and other preferred terms.
|
2022-06-06 06:32:10 -07:00
|
|
|
|
|
|
|
|
## Stack
|
|
|
|
|
|
|
|
|
|
- API server is written in Go with the [chi](https://github.com/go-chi/chi) router
|
|
|
|
|
- Persistent data is stored in PostgreSQL
|
|
|
|
|
- Temporary data is stored in Redis
|
2022-09-08 05:10:45 -07:00
|
|
|
- The frontend is written in TypeScript with React, using [Next](https://nextjs.org/) for server-side rendering
|
2022-10-03 01:59:30 -07:00
|
|
|
- Avatars are stored in S3-compatible storage ([MinIO](https://github.com/minio/minio) for development)
|
2022-06-06 06:32:10 -07:00
|
|
|
|
2022-06-16 15:00:52 -07:00
|
|
|
## Development
|
|
|
|
|
|
2022-09-08 05:10:45 -07:00
|
|
|
When working on the frontend, run the API and then use `yarn dev` in `frontend/` for hot reloading.
|
2022-06-16 15:00:52 -07:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
2022-09-08 05:10:45 -07:00
|
|
|
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](https://caddyserver.com/).
|
2022-06-16 15:00:52 -07:00
|
|
|
|
2022-09-08 05:10:45 -07:00
|
|
|
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/`.**
|
2022-06-16 15:00:52 -07:00
|
|
|
|
2022-06-06 06:32:10 -07:00
|
|
|
## 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/>.
|
