Skip to content

Commit

Permalink
fix: typos in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
madan-ideas2it committed Nov 14, 2024
1 parent 3a6f0df commit 8c6ca55
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Directory Backend

This is the PL Network backend built with [Nest](https://github.com/nestjs/nest), [Prisma](https://www.prisma.io/), and [PostgresSQL](https://www.postgresql.org/). The parent project is generated using [Nx](https://nx.dev/). Check the docs to learn more.
This is the PL Network backend built with [Nest](https://github.com/nestjs/nest), [Prisma](https://www.prisma.io/), and [PostgreSQL](https://www.postgresql.org/). The parent project is generated using [Nx](https://nx.dev/). Check the docs to learn more.

It is set up in monorepo (soon will be revamped to single microservice pattern) fashion currently hosting directory backend and directory frontend for admin (soon will be revamped).

Expand Down Expand Up @@ -187,14 +187,14 @@ $ yarn nx build web-api --configuration=production
## Test

```sh
$ nx run web-api:test
$ yarn nx run web-api:test
```
To ensure code reliability and functionality, we use the Jest framework for writing and running test cases. Jest provides a robust environment for unit and integration testing, helping maintain the quality and stability of the application.

## Lint

```sh
$ nx run web-api:lint
$ yarn nx run web-api:lint
```

## Running the Back Office (Admin app)
Expand All @@ -218,6 +218,10 @@ Application will be available at http://localhost:4201, port 4201 is set in proj

Use the username and password you set in the environment variables above to log in to the back office app.

### Commit Guidelines

Refer [here] (./docs/GUIDELINES_COMMIT.md)

### Contributing Guidelines

Refer
Expand Down
6 changes: 3 additions & 3 deletions apps/web-api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Directory Backend

This is the PL Network backend built with [Nest](https://github.com/nestjs/nest), [Prisma](https://www.prisma.io/), and [PostgresSQL](https://www.postgresql.org/). The parent project is generated using [Nx](https://nx.dev/). Check the docs to learn more.
This is the PL Network backend built with [Nest](https://github.com/nestjs/nest), [Prisma](https://www.prisma.io/), and [PostgreSQL](https://www.postgresql.org/). The parent project is generated using [Nx](https://nx.dev/). Check the docs to learn more.

It is set up in monorepo (soon will be revamped to single microservice pattern) fashion currently hosting directory backend and directory frontend for admin (soon will be revamped).

Expand Down Expand Up @@ -179,14 +179,14 @@ $ yarn nx build web-api --configuration=production
## Test

```sh
$ nx run web-api:test
$ yarn nx run web-api:test
```
To ensure code reliability and functionality, we use the Jest framework for writing and running test cases. Jest provides a robust environment for unit and integration testing, helping maintain the quality and stability of the application.

## Lint

```sh
$ nx run web-api:lint```
$ yarn nx run web-api:lint```


### Full type safety endpoint development
Expand Down

0 comments on commit 8c6ca55

Please sign in to comment.