Caravel

Introduction :

What is this project about ?

• This project is a my personal blog where you can find :
  • Public article where i write about software engineering (Pattern, Tools, Architecture, Product, Management, etc..)
  • Links to my personal projects
  • Information regarding myself (Curriculum vitae, hobbies, etc..)

🚀 How to run ? :

devcontainer :

In order to use devcontainer the requirements are :

• docker
• visual studio code
• dev container extension

Once the requirements are installed, open this repository using vscode.

It should :

• Open it inside a container
• Install the project
• Run the frontend under port 3000

Open http://localhost:3000

• Run the backend under port 3001

Open http://localhost:3001

• Run the database under port 5432

• Run Drizzle Studio under port 3002

Open Drizzle Studio

📋 Steps done by devcontainer :

• run containers via docker-compose
• install projects via pnpm install -r
• migrate database via db:migrate

🪴 Seeding

You can seed the database via database/seed

You can reset the database via database/reset

📡 Technologies

What technologies are you using ?

Frontend

This project uses :

• NextJS has a metaframework
• React has a frontend library
• Tailwind for the styling
• Shadcn has a UI library
• Sonner for Toaster

Blog

In order to run the blog i use the mdx format with plugins rehype, retype. I use the contentlayer library to manage the content.

Hosting

The hosting is managed by vercel :

• The file serving is DONE using lambda functions

Bakckend

This project uses :

• Hono has a server framework
• PostGRES has a database
• Drizzle has an ORM
• Zod has a Schema/validation tool

Architecture

graph TD;
    subgraph Client
        A[NextJS : frontend] --> B[about-me - CSR]
        A --> D[logbook - SSR]
        A --> E[projects - SSR]
    end

    subgraph Server
        C[api/download/curriculum]
    end

    subgraph Backend
        F[index]
    end

    B --> C

Loading