Crealcs Development DokuWiki

Modifiez cette page et cliquez sur « Enregistrer ». Voyez le guide de mise en page pour une aide à propos du formatage. Veuillez ne modifier cette page que si vous pouvez l'améliorer. Si vous souhaitez faire des tests, faites vos premiers pas dans le bac à sable.

====== Phase 1 — Fondation du dépôt (pas à pas complet) ======

===== Objectif =====

À la fin de cette phase, un développeur doit pouvoir exécuter :

<code bash>
docker compose up
</code>

et obtenir :

<code>
✓ PostgreSQL

✓ Redis

✓ MinIO

✓ API NestJS

✓ Frontend NextJS

✓ Swagger

✓ Prisma Studio </code>

sans aucun développement métier.

---

====== Étape 1 — Préparer le poste de développement ======

===== Installer les prérequis =====

Vérifier :

<code bash>
node -v
npm -v
git --version
docker --version
docker compose version
</code>

Versions recommandées :

<code>
NodeJS 22 LTS

npm 10+

Docker 27+

Git 2.45+ </code>

---

====== Étape 2 — Création du repository ======

===== Créer le dossier =====

<code bash>
mkdir rental-platform

cd rental-platform </code>

---

===== Initialiser Git =====

---

===== Créer le dépôt GitHub =====

Exemple :

<code>
rental-platform
</code>

Puis :

<code bash>
git remote add origin git@github.com:organisation/rental-platform.git
</code>

---

====== Étape 3 — Initialiser le monorepo ======

===== Créer package.json =====

---

===== Installer Turborepo =====

<code bash>
npm install -D turbo
</code>

---

===== Créer turbo.json =====

<code json>
{
  "$schema": "https://turbo.build/schema.json",
  "tasks": {
    "build": {
      "dependsOn": ["^build"]
    },
    "lint": {},
    "test": {},
    "dev": {
      "cache": false
    }
  }
}
</code>

---

====== Étape 4 — Créer l'arborescence ======

<code bash>
mkdir apps

mkdir packages

mkdir prisma

mkdir infrastructure

mkdir docs

mkdir .github </code>

---

===== Créer les sous-dossiers =====

<code bash>
mkdir apps/api

mkdir apps/web

mkdir apps/admin-portal

mkdir apps/owner-portal

mkdir packages/ui

mkdir packages/sdk

mkdir packages/shared

mkdir packages/eslint-config

mkdir packages/tsconfig </code>

---

====== Étape 5 — Initialiser NextJS ======

===== Front Office =====

<code bash>
npx create-next-app@latest apps/web \
--typescript \
--tailwind \
--eslint \
--app \
--src-dir
</code>

---

===== Back Office =====

<code bash>
npx create-next-app@latest apps/admin-portal \
--typescript \
--tailwind \
--eslint \
--app \
--src-dir
</code>

---

===== Extranet propriétaire =====

<code bash>
npx create-next-app@latest apps/owner-portal \
--typescript \
--tailwind \
--eslint \
--app \
--src-dir
</code>

---

====== Étape 6 — Initialiser NestJS ======

===== Installer Nest CLI =====

<code bash>
npm install -g @nestjs/cli
</code>

---

===== Générer l'API =====

Choisir :

---

===== Tester =====

<code bash>
cd apps/api

npm run start:dev </code>

Swagger sera ajouté ultérieurement.

---

====== Étape 7 — Configurer les Workspaces ======

===== Modifier package.json racine =====

<code json>
{
  "private": true,
  "workspaces": [
    "apps/*",
    "packages/*"
  ]
}
</code>

---

===== Installer les dépendances =====

<code bash>
npm install
</code>

---

====== Étape 8 — Installer Prisma ======

===== Dépendances =====

<code bash>
npm install prisma @prisma/client
</code>

---

===== Initialiser Prisma =====

<code bash>
npx prisma init
</code>

---

===== Vérifier =====

Le fichier doit exister :

<code>
prisma/schema.prisma
</code>

---

====== Étape 9 — Préparer Docker ======

===== Créer le dossier =====

<code bash>
mkdir infrastructure/docker
</code>

---

===== Créer docker-compose.yml =====

<code yaml>
services:

postgres:

```
image: postgres:17

environment:

POSTGRES_USER: postgres

POSTGRES_PASSWORD: postgres

POSTGRES_DB: rental_platform

ports:

- "5432:5432"
```

redis:

```
image: redis:7

ports:

- "6379:6379"
```

minio:

```
image: minio/minio

command: server /data

environment:

MINIO_ROOT_USER: minio

MINIO_ROOT_PASSWORD: minio123

ports:

- "9000:9000"

- "9001:9001"
```

</code>

---

===== Lancer =====

<code bash>
docker compose up -d
</code>

---

===== Vérifier =====

<code bash>
docker ps
</code>

Doit afficher :

<code>
postgres

redis

minio </code>

---

====== Étape 10 — Variables d'environnement ======

===== Créer .env =====

<code env>
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/rental_platform"

REDIS_URL="redis://localhost:6379"

MINIO_ENDPOINT="localhost"

MINIO_PORT=9000

MINIO_ACCESS_KEY=minio

MINIO_SECRET_KEY=minio123 </code>

---

====== Étape 11 — Premier modèle Prisma ======

===== Modifier schema.prisma =====

<code prisma>
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
provider = "prisma-client-js"
}

model User {

id        String @id @default(uuid())

email     String @unique

createdAt DateTime @default(now())
} </code>

---
En version prisma 7, il faut supprimer la ligne url dans le fichier du schema
---

<code prisma>
datasource db {
  provider = "postgresql"
}

generator client {
provider = "prisma-client-js"
}

model User {

id        String @id @default(uuid())

email     String @unique

createdAt DateTime @default(now())
}
</code>

---
et adapter le fichier de prisma.config.ts
---
<code>
import path from 'node:path'
import { defineConfig } from 'prisma/config'
import { PrismaPg } from '@prisma/adapter-pg'

export default defineConfig({
  earlyAccess: true,
  schema: path.join('prisma', 'schema.prisma'),
  migrate: {
    adapter() {
      return new PrismaPg({ connectionString: process.env.DATABASE_URL! })
    },
    url: process.env.DATABASE_URL!,  // 👈 this is what's missing
  },
})
</code>

===== Générer migration =====

<code bash>
npx prisma migrate dev --name init
</code>

---

===== Générer client =====

<code bash>
npx prisma generate
</code>

---

====== Étape 12 — Prisma Studio ======

===== Lancer =====

<code bash>
npx prisma studio
</code>

---

===== Vérifier =====

Naviguer :

<code>
http://localhost:5555
</code>

---

====== Étape 13 — Installer Swagger NestJS ======

===== Dépendances =====

<code bash>
cd apps/api

npm install @nestjs/swagger swagger-ui-express </code>

---

===== Modifier main.ts =====

<code typescript>
const config = new DocumentBuilder()
  .setTitle('Rental Platform API')
  .setVersion('1.0')
  .build();

const document = SwaggerModule.createDocument(
app,
config,
);

SwaggerModule.setup(
'swagger',
app,
document,
); </code>

---

===== Tester =====

<code>
http://localhost:3000/swagger
</code>

---

====== Étape 14 — GitHub Actions ======

===== Créer =====

<code>
.github/workflows/ci.yml
</code>

---

===== Contenu =====

<code yaml>
name: CI

on:
push:

jobs:

build:

```
runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4

- uses: actions/setup-node@v4

- run: npm install

- run: npm run build
```

</code>

---

====== Étape 15 — Premier commit ======

<code bash>
git add .

git commit -m "chore: initialize platform foundation"

git push -u origin main </code>

---

====== Critères de validation ======

La phase 1 est terminée lorsque :

<code>
✓ Monorepo opérationnel

✓ Turborepo opérationnel

✓ NextJS opérationnel

✓ NestJS opérationnel

✓ PostgreSQL opérationnel

✓ Redis opérationnel

✓ MinIO opérationnel

✓ Prisma opérationnel

✓ Swagger opérationnel

✓ Docker Compose opérationnel

✓ GitHub Actions opérationnel </code>

---

====== Livrable obtenu ======

À ce stade, le projet dispose d'un socle exécutable complet permettant d'entamer immédiatement :

<code>
Sprint 1

Authentification

Register

Login

JWT

RBAC

User Profile </code>

Résumé

Note : En modifiant cette page, vous acceptez que le contenu soit placé sous les termes de la licence suivante : CC Attribution-Share Alike 4.0 International