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
|
2023-03-11 07:58:36 -08:00
|
|
|
- The frontend is written in TypeScript with Svelte, using [SvelteKit](https://kit.svelte.dev/) 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
|
|
|
|
|
|
2023-03-11 07:58:36 -08:00
|
|
|
When working on the frontend, run the API and then use `pnpm dev` in `frontend/` for hot reloading.
|
2022-06-16 15:00:52 -07:00
|
|
|
|
2023-03-11 07:58:36 -08:00
|
|
|
Note that the Vite dev server assumes that the backend listens on `:8080` and MinIO listens on `:9000`.
|
|
|
|
|
If these ports differ on your development environment, you must edit `vite.config.ts`.
|
2022-12-22 06:42:43 -08:00
|
|
|
|
2022-11-19 18:37:52 -08:00
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
Requirements:
|
|
|
|
|
|
|
|
|
|
- Go 1.18 or later
|
|
|
|
|
- PostgreSQL (any currently supported version should work)
|
|
|
|
|
- Redis 6.0 or later
|
|
|
|
|
- Node.js (latest version)
|
2023-06-15 20:12:42 -07:00
|
|
|
- MinIO **if using avatars, flags, or data exports** (_not_ required otherwise)
|
2023-09-10 07:49:16 -07:00
|
|
|
- [Air](https://github.com/cosmtrek/air) for live reloading the backend
|
2022-11-19 18:37:52 -08:00
|
|
|
|
|
|
|
|
### Setup
|
|
|
|
|
|
2023-09-10 07:49:16 -07:00
|
|
|
1. Create a PostgreSQL user and database (the user should own the database).
|
2022-11-19 18:37:52 -08:00
|
|
|
For example: `create user pronouns with password 'password'; create database pronouns with owner pronouns;`
|
2023-06-15 20:12:42 -07:00
|
|
|
2. Copy `.env.example` in the repository root to a new file named `.env` and fill out the required options.
|
2023-03-23 02:49:49 -07:00
|
|
|
3. Run `go run -v . database migrate` to initialize the database, then optionally `go run -v . database seed` to insert a test user.
|
2023-09-10 07:49:16 -07:00
|
|
|
4. Run `pnpm dev`. Alternatively, if you don't want the backend to live reload, run `go run -v . web`,
|
|
|
|
|
then change to the `frontend/` directory and run `pnpm dev`.
|
2023-03-15 02:04:48 -07:00
|
|
|
|
2023-06-15 20:12:42 -07:00
|
|
|
See [`docs/production.md`](/docs/production.md#configuration) for more information about keys in the backend and frontend `.env` files.
|
|
|
|
|
|
2023-09-10 07:49:16 -07:00
|
|
|
### Seeding
|
|
|
|
|
|
|
|
|
|
To seed the database with some data, create a `seed.yaml` file, then use `go run -v . database seed`.
|
|
|
|
|
For the file format, refer to the `Seed` struct in `scripts/seeddb`.
|
|
|
|
|
|
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/>.
|
