quickjots

Jactum

QuickJots est une application Web pour noter et enregistrer automatiquement toutes les notes rapides dans votre navigateur, en utilisant Markdown ou en texte ordinaire. Aucune inscription n'est nécessaire et un mode sombre est disponible!

Les notes de texte brut et de marque sont prises en charge (à l'aide de Showdown).

Ce référentiel contient tout le code source pour le Web-App sur QuickJots.App.

QuickJots est actuellement hébergé à l'aide de NetLify, il existe donc également un fichier netlify.toml dans la racine pour configurer Netlify.

Commencer

Si vous souhaitez contribuer à Quickjots ou l'héberger vous-même, vous devrez débarquer ce dépôt via GitHub, suivi de:

QuickJots utilise WebPack Bundles le code source de ce dépôt en un site statique. Il utilise un travailleur de service pour fournir un support hors ligne.

Le code JavaScript principal est dans ./src/js - les fichiers utilisent tous l'objet window.quickjots de base et ajoutent toutes les fonctions et variables nécessaires à cela.

1. git clone [email protected]:[username]/quickjots.git
2. Assurez-vous que Node.js est installé (pour regrouper les fichiers avec webpack)
3. Exécutez yarn install dans le répertoire Root Repo pour installer les dépendances
4. Exécutez yarn start pour exécuter le serveur de développement WebPack sur votre port local 8080 tout en modifiant le code. Il sera le chargement automatique sur tout changement
5. Exécutez yarn build pour exécuter WebPack en mode de production pour générer des fichiers dans dist/ . Ces fichiers contiennent le site statique, pour que vous vous hébergez si vous voulez

Remarque Vous voudrez peut-être désactiver le travailleur du service dans Dev-Mode si vous testez de nombreuses modifications localement, sinon vous verrez l'ancien code fonctionner au lieu de votre nouveau code! Il existe également une option de «mise à jour sur le rechargement» dans Chrome Dev Tools pour les travailleurs de service si vous ne souhaitez pas le désactiver pour le mode Dev.

Contributif

Toutes les contributions telles que les rapports de bogues, les demandes de fonctionnalités ou les demandes de traction sont les bienvenues!

Il y a une configuration Eslint dans .eslintrc.json , mais en bref, le style de code principal est:

• Utiliser l'indentation à 2 espaces
• Utiliser des espaces pour l'indentation
• Utilisez des demi-colons à la fin des déclarations
• Utilisez les fonctions de flèche dans la mesure du possible