mirror/Compass
1
0
Fork 0
mirror of https://github.com/CompassConnections/Compass.git synced 2025-12-23 22:18:43 -05:00
Code Issues Packages Projects Releases Wiki Activity

Upgrade docs

Browse Source
This commit is contained in:
MartinBraquet
2025-09-16 23:49:17 +02:00
parent 8800d9adc6
commit 7321f56ee2
2 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -7,7 +7,7 @@
This repository contains the source code for [Compass](https://compassmeet.com) — an open platform for forming deep, authentic 1-on-1 connections with clarity and efficiency.
**We can’t do this alone.** Whatever your skills—coding, design, writing, moderation, marketing, or even small donations—you can make a real difference. [Contribute](https://www.compassmeet.com/about) in any way you can and help our community thrive!
**We can’t do this alone.** Whatever your skills—coding, design, writing, moderation, marketing, or even small donations—you can make a real difference. [Contribute](https://www.compassmeet.com/support) in any way you can and help our community thrive!
## Features
@@ -105,7 +105,7 @@ We can't make the following information public, for security and privacy reasons
- Firebase, otherwise anyone could remove users or modify the media files
- Email, analytics, and location services, otherwise anyone could use our paid plan
So, we separate all those services between production and local development, so that you can code freely without impacting the functioning of the platform.
We separate all those services between production and local development, so that you can code freely without impacting the functioning of the platform.
Contributors should use the default keys for local development. Production uses a separate environment with stricter rules and private keys that are not shared.
Most of the code will work out of the box. All you need to do is creating an `.env` file as a copy of `.env.example`:
@@ -113,8 +113,7 @@ Most of the code will work out of the box. All you need to do is creating an `.e
cp .env.example .env
```
Then, most of you can skip the rest of the section. If you do need one of the few remaining services, you need to store your own secrets as environment variables.
To do so, simply open `.env` and fill in the variables according to the instructions in the file.
If you do need one of the few remaining services, you need to store your own secrets as environment variables. To do so, simply open `.env` and fill in the variables according to the instructions in the file.
### Tests

12
docs/development.md
View File

@@ -3,18 +3,22 @@
> [!WARNING]
> TODO: This document is a work in progress. Please help us improve it by contributing!
See [knowledge.md](knowledge.md) for high-level architecture and design decisions.
See those other useful documents as well:
- [knowledge.md](knowledge.md) for high-level architecture and design decisions.
- [README.md](../backend/api/README.md) for the backend API
- [README.md](../backend/email/README.md) for the email routines and how to set up a local server for quick email rendering
- [README.md](../web/README.md) for the frontend / web server
### Adding a new profile variable
To add a profile variable (personality type, etc.), make modifications here:
* ...
Then update the database by running a migration:
You will likely need to update the `lovers` table of the database. Set up an SQL migration file that updates the table, as in [migrations](../backend/supabase/migrations), and run it in the same vein as [migrate.sh](../scripts/migrate.sh).
Sync the database types from supabase to the local files (which assist Typescript in typing):
```bash
...
yarn regen-types
```
### Cover with tests