Skip to content
This repository was archived by the owner on Apr 21, 2021. It is now read-only.

Commit 46ce4d6

Browse files
Updated README.md
1 parent 6b49bc8 commit 46ce4d6

File tree

1 file changed

+28
-24
lines changed

1 file changed

+28
-24
lines changed

README.md

+28-24
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,17 @@ The structure of this project allows us to easily scale workers in seconds. NATS
1818
- - This will remove the containers that were created
1919
- Use the Postman file in `./system/postman` to test API requests.
2020

21-
## Need a React frontend
21+
## Bonus
2222

23-
An integrated React frontend has been developed and can be found at [react.antd.fuse](https://github.com/nicolaspearson/react.antd.fuse)
23+
Need a React frontend or a Kubernetes deployment? See below!
2424

25-
### Captcha
25+
### React
2626

27-
Captcha codes have been integrated using reCaptcha. Register for v2 reCaptcha codes [here](https://www.google.com/recaptcha/intro/v3.html), then change the secrets in the environment variables accordingly.
27+
A React frontend has been developed and can be found at [react.antd.fuse](https://github.com/nicolaspearson/react.antd.fuse)
2828

29-
```
30-
"RECAPTCHA_SECRET": "<YOUR-SITE-KEY>"
31-
"RECAPTCHA_INVISIBLE_SECRET": "<YOUR-SITE-INVISIBLE-KEY>"
32-
```
33-
34-
## Need a Kubernetes deployment
29+
### Kubernetes
3530

36-
This project has been integrated with Kubernetes and can be found at [kubernetes.api.gateway](https://github.com/nicolaspearson/kubernetes.api.gateway)
31+
Kubernetes scripts for this project and can be found at [kubernetes.api.gateway](https://github.com/nicolaspearson/kubernetes.api.gateway)
3732

3833
## Development
3934

@@ -225,6 +220,15 @@ src
225220
   └── ...
226221
```
227222

223+
##### Captcha
224+
225+
Captcha codes have been integrated using reCaptcha. Register for v2 reCaptcha codes [here](https://www.google.com/recaptcha/intro/v3.html), then change the secrets in the environment variables accordingly.
226+
227+
```
228+
"RECAPTCHA_SECRET": "<YOUR-SITE-KEY>"
229+
"RECAPTCHA_INVISIBLE_SECRET": "<YOUR-SITE-INVISIBLE-KEY>"
230+
```
231+
228232
#### Redis
229233

230234
Redis serves primarily as the data store for caching `GET` request results of all of the microservices (individual configuration is required).
@@ -380,19 +384,19 @@ It is possible to debug code that is running in a docker container by following
380384
1. Add a new debug configuration to VS Code by opening `./.vscode/launch.json`, e.g.
381385

382386
```
383-
{
384-
"name": "Attach to Docker - Auth Service",
385-
"type": "node",
386-
"protocol": "inspector",
387-
"request": "attach",
388-
"restart": true,
389-
"address": "localhost",
390-
"sourceMaps": true,
391-
"skipFiles": ["node_modules"],
392-
"port": 9229,
393-
"localRoot": "${workspaceRoot}/auth-service/",
394-
"remoteRoot": "/home/app/node"
395-
}
387+
{
388+
"name": "Attach to Docker - Auth Service",
389+
"type": "node",
390+
"protocol": "inspector",
391+
"request": "attach",
392+
"restart": true,
393+
"address": "localhost",
394+
"sourceMaps": true,
395+
"skipFiles": ["node_modules"],
396+
"port": 9229,
397+
"localRoot": "${workspaceRoot}/auth-service/",
398+
"remoteRoot": "/home/app/node"
399+
}
396400
```
397401

398402
2. Edit the docker configuration file in order to enable debugging on the running Node.js process, e.g.

0 commit comments

Comments
 (0)