You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-15Lines changed: 24 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,20 +115,6 @@ Then, install the dependencies for this project:
115
115
yarn install
116
116
```
117
117
118
-
### Environment Variables
119
-
120
-
Almost all the features will work out of the box, so you can skip this step and come back later if you need to test the following services: email, geolocation.
121
-
122
-
We can't make the following information public, for security and privacy reasons:
123
-
- Database, otherwise anyone could access all the user data (including private messages)
124
-
- Firebase, otherwise anyone could remove users or modify the media files
125
-
- Email, analytics, and location services, otherwise anyone could use the service plans Compass paid for and run up the bill.
126
-
127
-
That's why we separate all those services between production and development environments, so that you can code freely without impacting the functioning of the deployed platform.
128
-
Contributors should use the default keys for local development. Production uses a separate environment with stricter rules and private keys that are not shared.
129
-
130
-
If you do need one of the few remaining services, you need to set them up and 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.
131
-
132
118
### Tests
133
119
134
120
Make sure the tests pass:
@@ -162,7 +148,16 @@ You can also add `console.log()` statements in the code.
162
148
163
149
If you are new to Typescript or the open-source space, you could start with small changes, such as tweaking some web components or improving wording in some pages. You can find those files in `web/public/md/`.
164
150
165
-
See [development.md](docs/development.md) for additional instructions, such as adding new profile fields.
151
+
##### Resources
152
+
153
+
There is a lof of documentation in the [docs](docs) folder, namely:
154
+
-[Next.js.md](docs/Next.js.md) for core fundamentals about our web / page-rendering framework.
155
+
-[knowledge.md](docs/knowledge.md) for general information about the project structure.
156
+
-[development.md](docs/development.md) for additional instructions, such as adding new profile fields.
157
+
-[backend/api/README.md](backend/api/README.md) for the backend API.
158
+
-[android/README.md](android/README.md) for the Android app.
159
+
160
+
There are a lot of useful scripts you can use in the [scripts](scripts) folder.
Finally, open a Pull Request on GitHub from your `fork/<branch-name>` → `CompassConnections/Compass` main branch.
191
186
187
+
### Environment Variables
188
+
189
+
Almost all the features will work out of the box, so you can skip this step and come back later if you need to test the following services: email, geolocation.
190
+
191
+
We can't make the following information public, for security and privacy reasons:
192
+
- Database, otherwise anyone could access all the user data (including private messages)
193
+
- Firebase, otherwise anyone could remove users or modify the media files
194
+
- Email, analytics, and location services, otherwise anyone could use the service plans Compass paid for and run up the bill.
195
+
196
+
That's why we separate all those services between production and development environments, so that you can code freely without impacting the functioning of the deployed platform.
197
+
Contributors should use the default keys for local development. Production uses a separate environment with stricter rules and private keys that are not shared.
198
+
199
+
If you do need one of the few remaining services, you need to set them up and 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.
200
+
192
201
## Acknowledgements
193
202
This project is built on top of [manifold.love](https://github.com/sipec/polylove), an open-source dating platform licensed under the MIT License. We greatly appreciate their work and contributions to open-source, which have significantly aided in the development of some core features such as direct messaging, prompts, and email notifications. We invite the community to explore and contribute to other open-source projects like manifold.love as well, especially if you're interested in functionalities that deviate from Compass' ideals of deep, intentional connections.
0 commit comments