https://github.com/sasha-hk/liquidator-api
Authentication API
https://github.com/sasha-hk/liquidator-api
docker-compose postgresql redis test-task
Last synced: 10 months ago
JSON representation
Authentication API
- Host: GitHub
- URL: https://github.com/sasha-hk/liquidator-api
- Owner: Sasha-hk
- Created: 2024-10-29T13:39:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-30T11:30:53.000Z (over 1 year ago)
- Last Synced: 2024-10-30T12:27:19.556Z (over 1 year ago)
- Topics: docker-compose, postgresql, redis, test-task
- Language: TypeScript
- Homepage:
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Liquidator API
What does it means?
1. liquid - like a liquid
2. ator - authenticator
There are 3 endpoints:
1. **/auth/register** - register
2. **/auth/log-in** - log-in
3. **/user** - get user info
There are [Swagger](http://localhost:8000/swagger) documentation.
After you run tests you can find coverage results in this [file](./coverage/lcov-report/index.html)
## How to run it?
Install packages:
```sh
yarn install
```
Start dev docker:
```sh
yarn start:docker:dev
```
Run migrations in dev DB:
```sh
yarn db:dev:migrate
```
Run tests:
```sh
yarn start:dev
```
Then you can open [Swagger](http://localhost:8000/swagger)
## How to tests it?
Install packages if not installed yet
```sh
yarn install
```
Start test docker:
```sh
yarn start:docker:test
```
Run migrations in test DB:
```sh
yarn db:test:migrate
```
Run tests:
```sh
yarn test:e2e
```
Test coverage results:
```
--------------------------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
--------------------------|---------|----------|---------|---------|-------------------
All files | 95.96 | 93.75 | 97.05 | 95.33 |
src | 73.33 | 100 | 50 | 71.42 |
app.module.ts | 100 | 100 | 100 | 100 |
app.ts | 100 | 100 | 100 | 100 |
drizzle.config.ts | 0 | 100 | 100 | 0 | 1-5
main.ts | 0 | 100 | 0 | 0 | 1-10
src/auth | 100 | 100 | 100 | 100 |
auth.controller.ts | 100 | 100 | 100 | 100 |
auth.module.ts | 100 | 100 | 100 | 100 |
src/auth/decorators | 83.33 | 0 | 100 | 83.33 |
get-user.decorator.ts | 83.33 | 0 | 100 | 83.33 | 14
src/auth/dto | 100 | 100 | 100 | 100 |
auth.dto.ts | 100 | 100 | 100 | 100 |
src/auth/guards | 100 | 100 | 100 | 100 |
auth-jwt.guard.ts | 100 | 100 | 100 | 100 |
src/auth/services | 100 | 100 | 100 | 100 |
auth.service.ts | 100 | 100 | 100 | 100 |
jwt-internal.service.ts | 100 | 100 | 100 | 100 |
src/config | 100 | 100 | 100 | 100 |
index.ts | 100 | 100 | 100 | 100 |
src/db | 100 | 100 | 100 | 100 |
schema.ts | 100 | 100 | 100 | 100 |
src/drizzle | 100 | 100 | 100 | 100 |
diozzle.service.ts | 100 | 100 | 100 | 100 |
drizzle.module.ts | 100 | 100 | 100 | 100 |
src/redis | 100 | 100 | 100 | 100 |
redis.module.ts | 100 | 100 | 100 | 100 |
redis.service.ts | 100 | 100 | 100 | 100 |
src/user | 100 | 100 | 100 | 100 |
user.controller.ts | 100 | 100 | 100 | 100 |
user.module.ts | 100 | 100 | 100 | 100 |
user.service.ts | 100 | 100 | 100 | 100 |
src/user-cache | 100 | 100 | 100 | 100 |
user-cache.module.ts | 100 | 100 | 100 | 100 |
user-cache.service.ts | 100 | 100 | 100 | 100 |
--------------------------|---------|----------|---------|---------|-------------------
```
## Social login concept
I would use standard flow:
1. user get URL
2. user go to the URL
3. user receive response with token
4. user send the token to our API
5. our API generate access JWT token end send it to a user
Diagram:
## For high load
I would use Kubernetes to scale pods if needed also I would use distributed database