Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeyAlmighty committed Jan 29, 2023
1 parent e379491 commit 5945c9a
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 38 deletions.
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## AcadaBrain

[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
> Your one stop shop for knowledge enrichment
![Logo](./assets/acada-brain-logo.svg)

Expand All @@ -10,6 +10,19 @@
$ npm install
```

### Architecture

- [Nest](https://github.com/nestjs/nest).
- [TypeScript](https://www.typescriptlang.org/).
- [PostgreSQL](https://www.postgresql.org/).
- [Docker Compose](https://docs.docker.com/engine/reference/commandline/compose/).

pre-commit/push hooks setup with [Husky](https://github.com/typicode/husky)

#### Authentication

[Passport.js](https://www.passportjs.org/) is used along with [passport-jwt](http://www.passportjs.org/packages/passport-jwt/) strategy for handling user authentication.

## Running the app

```bash
Expand All @@ -25,27 +38,24 @@ $ npm run start:prod

## Test

```bash
# unit tests
$ npm run test
### End-to-End Testing

End-to-End Testing via [Pactum.js](https://pactumjs.github.io/)
(See [E2E Tests](app.e2e-spec.ts))

Tests are ran against a test DB (spun up in a separate docker container).

```bash
# e2e tests
$ npm run test:e2e

# unit tests
$ npm run test

# test coverage
$ npm run test:cov
```

## Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).

## Stay in touch

- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)

## License

Nest is [MIT licensed](LICENSE).
[MIT licensed](LICENSE).
46 changes: 23 additions & 23 deletions assets/acada-brain-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5945c9a

Please sign in to comment.