Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
working commit
Browse files Browse the repository at this point in the history
prasadtalasila committed Sep 29, 2023
1 parent 08d156d commit 3d82e89
Showing 14 changed files with 651 additions and 214 deletions.
10 changes: 8 additions & 2 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@ cd client
yarn install #install the nodejs dependencies
yarn format #format .ts[x] and .js[x] files with prettier.
yarn syntax #perform linting and static analysis
yarn graph # generate dependency graphs in the code
yarn build #build the react app into build/ directory
yarn develop #start the development server without building. Great for live edits.

@@ -24,18 +25,23 @@ yarn start #start the application
yarn clean #clean the directory of temporary files
```

It is also possible to run different types of tests using the yarn test command by passing different flags:
It is also possible to run different types of tests using the yarn
test command by passing different flags:

```bash
yarn test -a #run all tests
yarn test -u #run unit tests
yarn test -i #run integration tests
yarn test -e #run end-to-end tests
```

---

## Authentication

The react client website uses OAuth authentication. The [authentication page](../docs/admin/client/auth.md) provides details on setting up oauth authentication for the client application.
The react client website uses OAuth authentication.
The [authentication page](../docs/admin/client/auth.md) provides details
on setting up oauth authentication for the client application.

## Custom configuration

2 changes: 0 additions & 2 deletions client/script/graph.bash
Original file line number Diff line number Diff line change
@@ -5,5 +5,3 @@ printf "Generate dependency graph for code"

madge --image src.svg src
madge --image test.svg test
#eval madge --image src.svg "$TS_CONFIG" "$EXTENSIONS" src
#madge --image test.svg --ts-config tsconfig.json --extensions ts,tsx test
12 changes: 11 additions & 1 deletion docs/developer/client/client.md
Original file line number Diff line number Diff line change
@@ -6,4 +6,14 @@ being developed as a React single page web application.

A dependency graph for the entire codebase of the react application is:

![React website dependency graph](client-dep-graph.svg)
## Dependency Graphs

The figures are the dependency graphs generated from the code.

### src directory

![src dependency graph](src.svg)

### test directory

![test dependency graph](test.svg)
12 changes: 12 additions & 0 deletions docs/developer/servers/lib/lib-ms.md
Original file line number Diff line number Diff line change
@@ -175,3 +175,15 @@ sequenceDiagram
deactivate FR
```

## Dependency Graphs

The figures are the dependency graphs generated from the code.

### src directory

![src dependency graph](src.svg)

### test directory

![test dependency graph](test.svg)
193 changes: 0 additions & 193 deletions docs/developer/servers/lib/src-dep-graph.svg

This file was deleted.

Loading

0 comments on commit 3d82e89

Please sign in to comment.