Tweeter clone with Adonis JS

Introduction

Bienvenue sur le projet Clone Tweeter, développé avec le puissant framework AdonisJS !

Nous sommes ravis de vous accueillir dans cette aventure où nous explorons les possibilités offertes par AdonisJS pour recréer une plateforme de microblogging dynamique et performante.

Objectifs pédagogiques

Nous allons :

• Configurer un projet AdonisJS.
• Définir des routes et des contrôleurs.
• Créer des vues avec le moteur de template Edge.
• Gérer une base de données avec un ORM
• Mettre en place un système d'authentification

À la fin de ce projet, vous aurez une compréhension du développement fullstack et vous serez en mesure de développer des applications Web plus complexes.

Prérequis

Avant de commencer ce projet, assurez-vous que vous avez les éléments suivants :

• Node.js version 20 minimum et npm installé sur votre ordinateur.
• Un éditeur de code (par exemple, Visual Studio Code).
• Des bonnes bases en html, css, JavaScript et TypeScript.

Installation

Pour installer ce projet, suivez les étapes suivantes. :

• Ouvrez donc le terminal à l'emplacement du dossier dans lequel vous voulez créer votre application et exécutez la commande suivante :

  git clone (url-de-mon-projet)
  

• Dirigez-vous dans le dossier cloné :

  cd (nom-de-mon-projet)
  

• Créez une nouvelle branche :

  git checkout -b nom-de-ma-branche
  

• Installez les dépendances du projet :

  npm install
  

• Commencez à coder :

  code .
  

• Créez un fichier .env

• Copier le contenu de .env.exemple et coller dans le fichier .env sauf la variable APP_KEY qui dois être générer en tapant la commande :

  node ace generate:key
  

Lancez votre projet

Pour lancer votre projet en mode développement tapez la commande :

npm run dev

🔗 Démo en ligne

Accédez à l’application déployée ici : xclone.up.railway.app

Contribution

Nous accueillons volontiers les contributions pour améliorer le projet ! Si vous souhaitez contribuer, veuillez suivre les étapes suivantes :

1. Forkez le dépôt.
2. Créez une nouvelle branche (git checkout -b feature/VotreFonctionnalite).
3. Apportez vos modifications et validez-les (git commit -m 'Ajout d’une fonctionnalité').
4. Poussez la branche (git push origin feature/VotreFonctionnalite).
5. Ouvrez une pull request.

Merci de contribuer à x-clone !