ReadFlow

Description

ReadFlow est une plateforme en ligne dédiée à la création, l'édition, et la personnalisation de README et de documentations techniques pour les développeurs. Le site vise à offrir une expérience simplifiée, moderne, et puissante, permettant aux utilisateurs de produire rapidement des documents de qualité professionnelle, tout en mettant à disposition des outils avancés et des templates sur mesure.

Table des Matières

• Installation
• Utilisation
• Variables d'Environnement
• Contribution
• Versions
• Auteurs
• Licence

Installation

1. Cloner le repository

   git clone https://github.com/ArthurDEV44/readflow
   cd readflow

2. Installer les dépendances

   npm install
   # ou
   yarn install

Utilisation

Pour démarrer le projet, utilisez la commande suivante :

npm run dev

# ou

yarn dev

Cela lancera l'application en mode développement. Vous pouvez ensuite accéder à l'application via http://localhost:3000.

Variables d'Environnement

Assurez-vous de configurer les variables d'environnement suivantes dans un fichier .env à la racine du projet :

• DATABASE_URL : URL de connexion à la base de données.
• NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY : Clé publique pour l'authentification.
• CLERK_SECRET_KEY : Clé secrète pour l'authentification.
• CLERK_WEBHOOK_SECRET : Secret pour les webhooks de Clerk.
• OPENAI_API_KEY : Clé API pour OpenAI.
• NEXT_PUBLIC_BASE_URL : URL de base de l'application.
• STRIPE_SECRET_KEY : Clé secrète pour Stripe.
• STRIPE_WEBHOOK_SECRET : Secret pour les webhooks de Stripe.

Contribution

Les contributions sont les bienvenues ! Pour contribuer, veuillez suivre ces étapes :

1. Forkez le projet.
2. Créez une nouvelle branche (git checkout -b ma-branche).
3. Faites vos modifications et committez (git commit -m 'Ajout d'une nouvelle fonctionnalité').
4. Poussez vos modifications (git push origin ma-branche).
5. Ouvrez une Pull Request.

Versions

N/A

Auteurs

• ArthurDEV44

Licence

Ce projet est sous la licence MIT.