https://github.com/Hemit99123/dailysat-node-api

API built for DailySAT, never used though :( Has authentication too!!
https://github.com/Hemit99123/dailysat-node-api

backend nodejs sessions

Last synced: 13 days ago
JSON representation

API built for DailySAT, never used though :( Has authentication too!!

• Host: GitHub
• URL: https://github.com/Hemit99123/dailysat-node-api
• Owner: Hemit99123
• Archived: true
• Created: 2024-09-08T01:44:16.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-24T17:45:57.000Z (about 1 month ago)
• Last Synced: 2025-01-17T00:33:25.218Z (13 days ago)
• Topics: backend, nodejs, sessions
• Language: TypeScript
• Homepage:
• Size: 200 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🚀 DailySAT API

**Overview:** The DailySat API powers the backend of the DailySat web platform, developed with ReactJS and TypeScript using the ViteJS buildpack.

## 💻 Technologies Used:

### Drizzle ORM

Drizzle serves as both an ORM and a query builder, providing a mid-level abstraction from SQL code for improved performance. Developers are expected to have SQL knowledge, which is considered a fair trade-off by the DailySat development team. For more information, check out this [YouTube Video](https://www.youtube.com/watch?v=b8W4bupOmxw).

### NodeJS with TSC

NodeJS is a runtime environment for JavaScript, enabling server-side execution of JavaScript code. This allows for a unified programming language across the web app and API, enhancing developer experience. Its asynchronous features and promise-based structure add to its appeal. TSC is the TypeScript compiler for NodeJS, as TypeScript is not natively supported.

### Redis Clusters

Redis is an in-memory database, storing data in RAM for faster access compared to traditional databases like SQL or NoSQL (e.g., MongoDB, Cassandra). However, this also means it is susceptible to data loss on server shutdown, making it suitable for ephemeral data like sessions and verification codes. Clusters enable horizontal sharding, improving scalability, especially for session-based authentication. Refer to this [YouTube Video](https://www.youtube.com/watch?v=2HvxYMdHYcY) for more information.

### Express Sessions

This technology abstracts session-based authentication logic from developers, leading to improved developer experience and adhering to industry best practices for security and scalability.

### Swagger

Swagger is used for seamless API documentation.

## 🧱 API Architecture:

The API logic is structured into three main folders:

- #### Controllers

Contains all business logic, including database queries for API endpoints.

- #### Routes

Includes all endpoints for specific logic types, such as authentication.

- #### Middleware

Houses code that runs before any other logic in an endpoint, useful for pre-processing requests, such as checking user authentication.

## 📝 Endpoint Docs:

To explore the different endpoints and their intended use cases, please navigate to the route `/api-docs` from the api endpoint.

[Database ER Diagram](https://drive.google.com/file/d/1Y9Yu9_crEV4aN3SZ9a_vSYKdIGGY7dxm/preview)