Skip to content

Commit 7321f56

Browse files
committed
Upgrade docs
1 parent 8800d9a commit 7321f56

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
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.
99

10-
**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!
10+
**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!
1111

1212
## Features
1313

@@ -105,16 +105,15 @@ We can't make the following information public, for security and privacy reasons
105105
- Firebase, otherwise anyone could remove users or modify the media files
106106
- Email, analytics, and location services, otherwise anyone could use our paid plan
107107

108-
So, we separate all those services between production and local development, so that you can code freely without impacting the functioning of the platform.
108+
We separate all those services between production and local development, so that you can code freely without impacting the functioning of the platform.
109109
Contributors should use the default keys for local development. Production uses a separate environment with stricter rules and private keys that are not shared.
110110

111111
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`:
112112
```bash
113113
cp .env.example .env
114114
```
115115

116-
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.
117-
To do so, simply open `.env` and fill in the variables according to the instructions in the file.
116+
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.
118117

119118
### Tests
120119

docs/development.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33
> [!WARNING]
44
> TODO: This document is a work in progress. Please help us improve it by contributing!
55
6-
See [knowledge.md](knowledge.md) for high-level architecture and design decisions.
6+
See those other useful documents as well:
7+
- [knowledge.md](knowledge.md) for high-level architecture and design decisions.
8+
- [README.md](../backend/api/README.md) for the backend API
9+
- [README.md](../backend/email/README.md) for the email routines and how to set up a local server for quick email rendering
10+
- [README.md](../web/README.md) for the frontend / web server
711

812
### Adding a new profile variable
913

1014
To add a profile variable (personality type, etc.), make modifications here:
11-
1215
* ...
1316

14-
Then update the database by running a migration:
17+
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).
1518

19+
Sync the database types from supabase to the local files (which assist Typescript in typing):
1620
```bash
17-
...
21+
yarn regen-types
1822
```
1923

2024
### Cover with tests

0 commit comments

Comments
 (0)