X-Git-Url: https://git.r.bdr.sh/rbdr/forum/blobdiff_plain/32ec81f6370328833fd0ba3dfe1c2974ac775973..HEAD:/doc/README.md?ds=inline diff --git a/doc/README.md b/doc/README.md index f294b0f..0d14a40 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,85 +1,32 @@ -## Modules +forum / [Exports](modules.md) -
The Forum class is the main entry point for the backend application.
-object
The main configuration object for the Forum backend. It will be used to -initialize all of the sub-components. It can extend any property of -the forum object.
-object
Configures the behavior of the JWT token.
-object
Information required to connect to the rethinkDB server
-tForumBackendConfiguration
](#tForumBackendConfiguration) | the initialization options to extend the instance |
+## Testing
-
+You can run tests with `npm test`. The tests use `testing-library`, `pact`,
+and `jest`.
-### forum.run()
-Initializes the application and starts listening. Also prints a
-nice robotic banner with information.
+Here's some short guidelines:
-**Kind**: instance method of [Forum
](#module_Forum)
-
-
-## tForumBackendConfiguration : object
-The main configuration object for the Forum backend. It will be used to
-initialize all of the sub-components. It can extend any property of
-the forum object.
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| [port] | number
| 1978
| the port where the app will listen on |
-| [staticDirectory] | string
| "static"
| the path, relative to the project root, where static assets live |
-| [ttl] | number
| 180
| the time in seconds that posts remain alive |
-| rethinkDB | [tRethinkDBConfiguration
](#tRethinkDBConfiguration) | | the configuration to connect to the rethinkDB server |
-| jwt | [tJWTConfiguration
](#tJWTConfiguration) | | the configuration for the JWT authentication |
-
-
-
-## tJWTConfiguration : object
-Configures the behavior of the JWT token.
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| [duration] | number
| 86400
| the duration of the JWT in seconds |
-| secret | string
| | the secret used to sign the JWT |
-
-
-
-## tRethinkDBConfiguration : object
-Information required to connect to the rethinkDB server
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| host | string
| | the location of the rethinkDB host |
-| [post] | string
| 6379
| port where rethinkDB server is listening |
+- Every component that receives props or changes state should be tested.
+- Test expected outcomes, not implementation details.
+- Avoid mocking unless it's an external call
+- Stores that interact with the API should be tested using pact
+[node]: https://nodejs.org/en/
+[forum-server]: https://gitlab.com/rbdr/forum-server