"Adeeb أديب"'s Backend

E-Commerce for printing Arabic Literature. Using SSR frontend with REST API, gRPC API and Protocol Buffers.

Overview

• Tech stack:

  • Adeeb API:

    • TypeScript
    • Nodejs and Express.js
    • Database:
      • Postgres and TypeORM
      • Caching with Redis ValKey
    • Docker Containerization

  • Users-service API:

    • Go
    • Database:
      • Postgresql with Sqlc and Pgx
    • Docker Containerization

• Characteristics:

  • Regression tests with Vitest.
  • CI using Github actions testing
  • JWT Authentication & Authorization
  • Centralized Error Handling
  • Data Validation with Yup and express-validator
  • Documentation with TSdoc and TypeDoc.
  • Security best practices from OWASP
  • Secrets handling.
  • Using Proto Buffers
  • …and more

File Structure

• ./github for Github actions.

• ./adeeb folder that encapsulate Adeeb API

• ./proto folder that contains our Proto Buffers

• ./users-service folder that contains Users-service API.

• ./compose.yaml file to build and start full aplication with docker-compose.

• ./Setup.md file to help to start the application.

• You can visit ./adeeb/Readme.md and ./users-servivce/Readme.md to read more about specific information about the project.

Roadmap

After building the project, Adeeb's team got some notes that they should use the pre-existing Users service, rather than duplicating the service with their partner functionality.

The service is built with Go and it exposes a gRPC server, which is used for:

• Managing and Keeping track of all users which uses our company services, noting which service did the user have sign for (becuase signing for one service doesn't mean they want to sign to all services)
• JWT Authentication and Authorization

We need to refactor partner component to:

• remove partner's entity from Adeeb's database. (as long as the order uses the jwt token, it doesn't need to confirm that the user id exist in our database.)
• use gRPC to make signups, logins and delete accounts from Users service.
• give Adeeb backend access to JWT public key only.
• ...and more.

You'll find the ongoing work in partner-grpc branch