https://github.com/oltarasiuk/eclair-auth

Test task: REST API Auth template
https://github.com/oltarasiuk/eclair-auth

class-validator drizzle-orm jest nestjs passport-jwt passport-local postgresql redis supertest swagger typescript

Last synced: 12 days ago
JSON representation

Test task: REST API Auth template

• Host: GitHub
• URL: https://github.com/oltarasiuk/eclair-auth
• Owner: oltarasiuk
• Created: 2024-10-31T15:41:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-01T19:44:22.000Z (over 1 year ago)
• Last Synced: 2026-05-16T12:35:55.081Z (27 days ago)
• Topics: class-validator, drizzle-orm, jest, nestjs, passport-jwt, passport-local, postgresql, redis, supertest, swagger, typescript
• Language: TypeScript
• Homepage:
• Size: 165 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Eclair (auth template)

**Note**: Redis does not work in Docker Compose due to the use of the `@nestjs-modules/ioredis` library. For more information, refer to the [issue](https://github.com/nest-modules/ioredis/issues/280).

## Introduction

Eclair-auth is a starting template for a user REST API authentication, designed with scalability and maintainability in mind.

## Technologies Used

- **TypeScript**

- **Nest.js**

- **Drizzle ORM**

- **PostgreSQL**

- **Redis**

- **Jest and Supertest**

- **Swagger**

- **Class-validator**

- **Winston**

- **PassportJS**

## Part 2 - What If (scaling)

Scaling can be approached from both the backend and DevOps perspectives. From a DevOps standpoint, one option is to create a database cluster to enhance the speed of record writing and retrieval. Additionally, deploying multiple backend instances can help manage traffic effectively. Vertical scaling is also an option by increasing the capacity of each individual server.

On the backend side, we can focus on minimizing load through rate limiting, caching, and implementing message queues. Redirecting long-running tasks to workers or microservices can further improve performance. It's also essential to optimize the database using indexing and normalization techniques to ensure efficient data management.

## Part 3 - Social Login

I would implement social login using PassportJS. However, I can't provide a detailed sequence diagram without knowing specific project details, such as whether users can be logged in to the same account on multiple devices, which social integrations are required, and how the frontend handles authentication.

Generally, the flow would involve redirecting the user to the appropriate social service for login, receiving an access token upon successful authentication, storing user information in the database, and then returning the necessary data to the frontend.