Skip to content

Latest commit

 

History

History
133 lines (92 loc) · 10.9 KB

README.md

File metadata and controls

133 lines (92 loc) · 10.9 KB


Compass-HG

◦ Report to IT with tickets

Developed with the software and tools listed below :

Vercel Sveltekit Typescript Node.js Drizzle ORM SQlite SQlite

📒 Table of Contents

📍 Résumé

Compass-HG est une application web pour gérer les tickets destiné au service informatique. Elle permet de créer des tickets.

🛠️ Outils et services

Vercel

Documentation

Vercel est une plateforme de déploiement pour les applications statiques et les fonctions serverless. Elle permet de déployer des applications en quelques secondes.

Sveltekit

Documentation

Sveltekit est un framework pour svelte. Il permet de créer des applications web avec svelte. Il permet de gérer les routes, les pages, les composants et les stores. Il a aussi plusieurs outils pour gérer les dépendances, les tests et le déploiement.

Drizzle ORM

Documentation

Drizzle ORM est un orm pout typescript. Il ce veux être proche de sql dans son utilisation. Il permet de gérer les tables, les relations et les requêtes. Il a aussi plusieurs outils pour gérer les migrations et manager la base de donnée avec un gui.

AuthJS

Documentation

AuthJS est une librairie pour gérer l'authentification. Elle permet de gérer les utilisateurs, les sessions et d'utiliser des providers externes ainsi que d'utiliser un base de donnée.

📚 Documentation

Deployment

Besoin

  • Compte github.
  • Compte vercel (avec le compte github).
  • Compte turso (avec le compte github).

Etapes

  1. Forker le projet sur github.
  2. Ce connecter sur azure-portal et créer une application.
  3. Garder de coté le client id et le client secret et tenant id.
  4. Rajouter les access au graph api (user.read, mail.send).
  5. Installer turso cli sur wsl (ou linux/macos).
  6. Créer la base de donnée avec turso cli et générer un token.
  7. Garder de coté le url et le token de la base de donnée.
  8. Setup les tables :
turso db shell [db name] < [path to sql file]
  1. Créer un projet sur vercel avec le fork.
    • Utiliser les variables d'environnement du fichier .env.example.
    • La variable SECRET est a remplir avec un générateur.

Development

Recommandé

Setup

  1. Cloner le fork en local.
  2. Copier le fichier .env.example en .env et remplir les variables.
    • La variable DATABASE_URL peux etre remplie avec un fichier sqlite ou en utilisant le turso cli.
    turso dev -f [path to save file]
  3. Installer les dépendances :
pnpm install
  1. Lancer le serveur :
pnpm dev
  • Si les schema de la base de donnée change, il faut les mettre a jour :
pnpm generate
  • Un outils pour voir la base de donnée :
pnpm studio
---
DATABASE_URL="..." DATABASE_AUTH_TOKEN="..." pnpm studio