🧀 Cheesus

Welcome! Cheesus is simple website and API for showing available cheeses that we have in our physical store. Who knows - maybe we'll accept and extend to payments.

🏛️ Architecture

graph LR

    A((Frontend - Angular))
    B{API - NestJS}
    C[(DB)]
    D[[Contracts - ZOD]]

    D -.-> A
    D -.-> B
    
subgraph Contracts Enforced Communication Via ts-rest

    A <-->|ts-rest| B
    B <-->|typeorm| C
end

📁 Project Structure

📦 Packages

@cheesus/api - Built using the NestJS framework. Contracts/validation read from @cheesus/contracts.
@cheesus/frontend - Built in angular. Uses ts-rest/core client package library to communicate with the API - with DTO/Validation from @cheesus/contracts.
@cheesus/contracts - Built using TypeScript and Zod for validation. Contains all the shared DTOs and validation for the API and Frontend.

🤝 Frontend/API Communication

API utilizes ts-rest - which reads contracts (i.e DTO) from @cheesus/contracts and generates a type safe client for @cheesus/frontend while also providing validation and types for @cheesus/api.
- This allows us to make changes to the API and have immediate feedback in the frontend.
- note: contract changes require a yarn build:contracts currently when there are any changes.

🏃 Getting Started

Clone the project at https://github.com/wlee88/cheesus

Locally

Ensure you have installed:
- nvm to ensure you have the correct node version
- yarn to manage the packages
- Docker to have a DB running.
Run nvm install to ensure you have the correct node version.
Run yarn to install the packages.
Start a local DB

docker run --name cheesus-db-local -e POSTGRES_USER=master -e POSTGRES_PASSWORD=password -e POSTGRES_DB=cheesus -p 5432:5432 -d postgres

Run yarn start:api - Available at http://localhost:3000
Run yarn start:frontend Available at Frontend - Available at http://localhost:4200

docker-compose

Ensure you have Docker installed.
Run docker-compose -f docker-compose.yml up
API available at http://localhost:3000
Frontend available at http://localhost:4200

⛙ CI/CD

Github actions is used for CI
There is a workflow that runs on every push to main branch for the following steps for api and frontend.
- build
- test

🚢 Port Reservations

Production

DB: 5432
API: 3000
Frontend: 4200

Test

DB: 5433

📋 Still Todo before we can consider production ready

Validation (frontend price calculator form/more api validation)
Integration tests - that run against the API through to DB
End to End tests - that run against the frontend through to the API
Authentication/admin area and better description field for blog like content that supports markdown and image uploads
A slug-url implementation and better ids for cheese items instead of the crude number id.
Better endpoints with index db columns for filtering.
Metrics/logs capture (Cloudwatch logs could do for now if we deploy via AWS)
Healthcheck API route/Actual deployment and code (terraform/pulumi/CloudFormation)
Github Workflow for deployment
CDN setup/Load Balancing/Route53 domain setup
Design and handling of different image aspect ratios is nonexistent.
Pagination for handling alot more cheese.
nice to have: use nx for smarter monorepo management and builds (i.e would only publish and run frontend tests if frontend code changes detected

😮 Troubleshooting

It's not detecting @cheesus/contract import changes

Ensure the changes are built with yarn build:contracts.

Unable to connect to the database.

The error might look like this:

[Nest] 8824  - 04/20/2024, 2:19:57 PM   ERROR [TypeOrmModule] Unable to connect to the database. Retrying (1)...
AggregateError
    at internalConnectMultiple (node:net:1116:18)
    at afterConnectMultiple (node:net:1683:7)

Ensure the DB is running and the connection string is correct in the .env file

👋 Questions?

Submit an issue and i'll answer when i can.

wlee88 / cheesus