makeread.me Download makeread.me Téléchargement du code source

makeread.me

Données du site Web

1.0.0

Télécharger

makeread.me

Un génial générateur de lecture pour relancer vos projets!

Explorez les documents »

Afficher la démo. Rapport Bug. Demande de demande

Table des matières

Table des matières
À propos du projet
- Construit avec
Commencer
- Condition préalable
- Installation
Feuille de route
Contributif
Licence
Contact
Remerciements
Avis

À propos du projet

Capture d'écran

L'un des défis de la construction et de la contribution aux logiciels open source est que, bien que de nombreux projets aient des fonctionnalités incroyables, elles manquent souvent d'atteindre un public plus large en raison du manque d'instructions d'installation claires et conviviales. De plus, le manque de vitrine efficace de leurs cas d'utilisation contribue également à la moindre portée de ces projets.

Bien qu'il existe des modèles ReadMe qui peuvent aider à résoudre ce problème, le processus de remplissage manuellement de ces modèles peut être long et fastidieux. C'est là que notre projet Makeread.me arrive.

Présentation de MakeRead.me, un générateur de lecture automatisé qui peut révolutionner la façon dont vous créez la documentation de votre projet. Il est conçu pour:

Gardez votre temps précieux à améliorer votre concentration sur le développement,
Automatiser les tâches redondantes, et,
Implémentez les principes secs (ne vous répétez pas) à votre documentation.

Il est gratuit, open-source et hautement personnalisable. N'hésitez pas à modifier nos modèles pour répondre à vos besoins. Si vous constatez qu'un composant particulier est manquant, vous êtes plus que bienvenu pour contribuer et développer le projet.

Nous vous avons facilité la contribution du projet en utilisant des modèles Nunjucks et JSON pour la cartographie programmatique. Profitez des avantages d'une documentation de projet claire et concise avec Makeread.me!

Construit avec

Ce projet a été construit avec les technologies suivantes:

Next.js
Réagir
Shadcn / ui
REACT HOW FORM
Manuscrit
Exprimer

Commencer

Ceci est un exemple de la façon dont vous pouvez donner des instructions sur la configuration de votre projet localement. Pour obtenir une copie locale en cours, suivez ces exemples d'exemples simples.

Condition préalable

Ce projet nécessite que le fil soit installé dans votre système. Si vous ne l'avez pas installé, vous pouvez suivre ces étapes:

Installez le fil globalement à l'aide de NPM (Node Package Manager). Ouvrez votre terminal et courez:
```
npm install -g yarn
```
Veuillez vous assurer que Node.js et NPM sont installés avant d'exécuter du fil.
Vérifiez que le fil a été installé sur votre machine en exécutant la commande suivante dans votre terminal:
```
yarn --version
```
Si le fil a été installé correctement, votre terminal doit afficher la version du fil installé sur votre machine.

Maintenant, vous êtes prêt à utiliser le fil pour gérer et verser la version de vos dépendances de projet!

Installation

Veuillez suivre les étapes suivantes pour une installation réussie:

Clone le référentiel: commencez par le clonage du référentiel vers votre machine locale.
```
 https://github.com/ShaanCoding/makeread.me
```
Installez les packages Frontend: accédez au répertoire "/ frontend" et installez les packages de fils requis en exécutant la commande suivante dans votre terminal:
```
yarn install
```
Installez les packages backend: de même, accédez au répertoire "/ backend" et installez les packages de fils requis en exécutant la commande suivante dans votre terminal:
```
yarn install
```
Configuration de l'environnement:
- Dans le répertoire "/ backend", copiez le contenu du fichier ".env.example" et créez un nouveau fichier nommé ".env". Ajustez les variables d'environnement en fonction de vos besoins ou vous pouvez les laisser telles qu'elle est.
- Accédez à "Frontend / API / généré / readmeGenerator.ts" et définissez le paramètre de base sur votre route API Backend. Par exemple, si vous courez le backend sur votre serveur local au port 8080, vous devez définir:
```
BASE: "http://localhost:8080/api" ;
```
Exécutez le répertoire backend: accédez au répertoire "/ backend" et saisissez la commande suivante dans votre terminal pour exécuter votre serveur backend:
```
yarn dev
```
Exécutez le frontend: Enfin, accédez au répertoire "/ frontend" et saisissez la commande suivante dans votre terminal pour exécuter votre serveur Frontend:
```
yarn dev
```
Maintenant, votre application devrait être opérationnelle avec succès!

Feuille de route

La feuille de route comprend à la fois des objectifs terminés et futurs. Voici ce que nous avons accompli et impatient de:

Nous continuons notre engagement à améliorer et à élargir les capacités de Makeread.

Voir les problèmes ouverts pour une liste complète des fonctionnalités proposées (et des problèmes connus).

Contributif

Les contributions font de la communauté open source un endroit incroyable pour apprendre, inspirer et créer. Toutes les contributions que vous faites sont grandement appréciées .

Si vous avez une suggestion qui améliorerait cela, veuillez débarquer le dépôt et créer une demande de traction. Vous pouvez également ouvrir simplement un problème avec la balise "amélioration". N'oubliez pas de donner une étoile au projet! Merci encore!

Fourk le projet
Créez votre branche de fonctionnalité ( git checkout -b feature/AmazingFeature )
Commissez vos modifications ( git commit -m 'Add some AmazingFeature' )
Push to the Branch ( git push origin feature/AmazingFeature )
Ouvrir une demande de traction