Skip to content

Commit 2f5ed8e

Browse files
authored
Merge branch 'develop-postgres' into husky_automation
2 parents 62051f9 + 84562a3 commit 2f5ed8e

File tree

2 files changed

+81
-12
lines changed

2 files changed

+81
-12
lines changed

docs/docs/docs/developer-resources/testing.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,24 @@ If the API:
1414
2. the API sample database is loaded;
1515
then you can use these login credentials to access the API via various clients.
1616

17-
| Email | Password | User Type | Joined Organization |
18-
| -------------------------- | -------- | --------------| -------------------- |
19-
| administrator@email.com | password | Administrator | N/A |
17+
| Email | Password | User Type | Joined Organization |
18+
| -----------------------------------| -------- | ---------------| -------------------- |
19+
| administrator@email.com | password | Administrator | N/A |
20+
| testsuperadmin@example.com | Pass@123 | Administrator | N/A |
21+
| testadmin1@example.com | Pass@123 | Administrator | N/A |
22+
| testadmin2@example.com | Pass@123 | Administrator | N/A |
23+
| testadmin3@example.com | Pass@123 | Administrator | N/A |
24+
| testuser1@example.com | Pass@123 | Regular | N/A |
25+
| testuser2@example.com | Pass@123 | Regular | N/A |
26+
| testuser3@example.com | Pass@123 | Regular | N/A |
27+
| testuser4@example.com | Pass@123 | Regular | N/A |
28+
| testuser5@example.com | Pass@123 | Regular | N/A |
29+
| testuser6@example.com | Pass@123 | Regular | N/A |
30+
| testuser7@example.com | Pass@123 | Regular | N/A |
31+
| testuser8@example.com | Pass@123 | Regular | N/A |
32+
| testuser9@example.com | Pass@123 | Regular | N/A |
33+
| testuser10@example.com | Pass@123 | Regular | N/A |
34+
| testuser11@example.com | Pass@123 | Regular | N/A |
2035

2136
## Accessing the API
2237

docs/docs/docs/getting-started/installation.md

+63-9
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,62 @@ Your new 64-character JWT secret will be displayed on the screen.
136136
1. Copy this secret
137137
2. Add it to the `API_JWT_SECRET` value in the `.env` file.
138138

139+
##### Update the API_ADMINISTRATOR_USER Credentials
140+
141+
You will need to update the `.env` file with the following information.
142+
1. `API_ADMINISTRATOR_USER_NAME` is the name of the primary administrator person.
143+
2. `API_ADMINISTRATOR_USER_EMAIL_ADDRESS` is the email address of the primary administrator. This will be required for logins.
144+
3. `API_ADMINISTRATOR_USER_PASSWORD` is plain text and is used for logins.
145+
146+
##### Update the MINIO Credentials
147+
148+
You will need to update the `.env` file with the following information.
149+
1. `MINIO_ROOT_PASSWORD` is a plain text password of your choosing.
150+
1. `API_MINIO_SECRET_KEY` is a plain text password of your choosing.
151+
152+
153+
##### Update the PostgreSQL Credentials
154+
155+
You will need to update the `.env` file with the following information. The passwords are in plain text and must match.
156+
1. `API_POSTGRES_PASSWORD`
157+
2. `POSTGRES_PASSWORD`
158+
159+
##### Update the API_BASE_URL Value
160+
161+
You will need to update the `.env` file with the following information. This value uses the expected defaults.
162+
163+
```
164+
http://127.0.0.1:4000
165+
```
166+
167+
##### Update the CADDY Configuration
168+
169+
You will need to update the `.env` file with the following information. This value uses the expected defaults.
170+
1. `CADDY_TALAWA_API_DOMAIN_NAME` can be set to `localhost`
171+
2. `CADDY_TALAWA_API_EMAIL` can be set to a suitable email address
172+
173+
##### Update the Social Media URLs
174+
175+
You will need to update the `.env` file with the following information.
176+
177+
```
178+
API_COMMUNITY_FACEBOOK_URL
179+
API_COMMUNITY_GITHUB_URL
180+
API_COMMUNITY_INSTAGRAM_URL
181+
API_COMMUNITY_LINKEDIN_URL
182+
API_COMMUNITY_REDDIT_URL
183+
API_COMMUNITY_SLACK_URL
184+
API_COMMUNITY_WEBSITE_URL
185+
API_COMMUNITY_X_URL
186+
API_COMMUNITY_YOUTUBE_URL
187+
```
188+
##### Update the Name of the Parent Organization / Community
189+
190+
You will need to update the `.env` file with the following information.
191+
```
192+
API_COMMUNITY_NAME
193+
```
194+
139195
#### Start the App
140196

141197
1. Start the server by running the following command:
@@ -206,16 +262,14 @@ These steps are specific to Linux. You will need to modify them accordingly for
206262
```bash
207263
cp envFiles/.env.devcontainer .env
208264
```
209-
1. Install `pnpm` using `codepack`
210-
```bash
211-
corepack install -g pnpm
212-
```
265+
1. Install Node.js
266+
1. Linux
267+
1. Install `node` from the [Node Source website](https://github.com/nodesource/distributions)
268+
1. Windows / Mac / Linux
269+
1. Install `node` from the [Node website](https://nodejs.org)
270+
1. Install `pnpm` from the [pnpm website](https://pnpm.io/installation)
213271
1. Linux / MacOS Only
214-
1. Setup `pnpm` to be automatically configured on all future terminal session logins using your `~/.bashrc` file.
215-
```bash
216-
pnpm setup
217-
```
218-
2. Enable `pnpm` for your current terminal session.
272+
1. Enable `pnpm` for your current terminal session.
219273
```
220274
source ~/.bashrc
221275
```

0 commit comments

Comments
 (0)