dev jot

dev-jot (version par défaut) - https://dev-jot.netlify.app

Dev-Jot est une application de prise de notes pour les tutoriels de développeurs en ligne. Le projet est un MVP et a été créé pour aider les aspirants développeurs frontaux dans le cadre du système de support FrontendCoach.

Il existe deux versions de l'application:

1. Par défaut, version Vanilla: https://dev-jot.netlify.app
2. React Version: https://dev-jot-react.netlify.app

Veuillez vous joindre à notre communauté Discord Discord.gg/ymsd9sgz4f

Objectif du projet

Pour ceux qui enseignent l'auto-enseignement, il est vraiment facile de se retrouver coincé dans le «tutoriel-terrasse» ou le «tutoriel-hell». Pour de nombreux codeurs débutants, il est difficile de combler l'écart entre ce que vous apprenez des tutoriels et acquérir les compétences dont vous avez besoin pour devenir un développeur employable.

Votre objectif ultime est de reproduire ce que vous feriez réellement dans un travail de développement réel aussi étroitement que possible. Contribuer à l'open source est un moyen fantastique de le faire. Faire des contributions open source vous obligera à avoir été exposée à quelques concepts, pratiques et compétences transférables importants:

• Contrôle de version
• Travailler avec des billets et des problèmes
• Travailler avec d'autres développeurs
• Création de demandes de traction
• Vivre un processus d'examen du code
• Mettre en place un environnement de développement local
• Code contribuant à une base de code préexistante

L'idée générale

Ce projet agit comme un point d'entrée amical dans le monde open source. Faire votre première contribution open source peut être une perspective intimidante qui décourage de nombreux développeurs en herbe.

L'objectif principal de ce projet est de créer un environnement accueillant et amical pour favoriser l'apprentissage, de se sentir en sécurité pour faire des erreurs et recevoir des commentaires et des conseils tout en travaillant avec d'autres développeurs.

La direction du projet sera dirigée par ceux qui contribuent. Il est possible d'ajouter une grande variété de fonctionnalités et également de reconstruire l'application avec différentes technologies.

État actuel

Il s'agit d'une application crud sans thrills. Les notes de cours sont actuellement stockées dans le stockage local du navigateur. Le but de l'application est de permettre à ceux qui sont auto-enseignés de créer un magasin simple et propre pour tous leurs notes de tutoriel et de cours.

Il existe deux versions de l'application. La version principale par défaut est située dans le répertoire app-main . Cette version par défaut de l'application est purement HTML, CSS et Vanilla JavaScript, il existe donc des opportunités d'apprentissage pour les contributeurs pour travailler avec les fondamentaux.

La deuxième version est construite à l'aide de React et est située dans le répertoire app-react . Cela offre une opportunité aux contributeurs qui cherchent à travailler avec un cadre frontal pour se salir les mains.

Avant de contribuer, je vous recommande fortement de jouer avec la version en direct et de l'utiliser pour une prise de notes de base. Qu'est-ce qui craint à ce sujet? Qu'est-ce qui pourrait être amélioré? Avez-vous repéré des insectes?

La direction du projet sera déterminée par ceux qui contribuent. Si vous avez des idées sympas pour les nouvelles fonctionnalités grandes ou petites, alors super! Créez simplement un problème de discussion avant de le faire?

Configuration du projet

Le moyen le plus simple et le plus rapide d'obtenir le projet par défaut opérationnel localement est de cloner le repo:

git clone https://github.com/jrobind/dev-jot.git

Assurez-vous que vous êtes dans le répertoire app-main

 cd app-main

Installez maintenant les packages avec NPM

npm i

Étant donné que la version du projet par défaut utilise des modules JavaScript, vous pouvez rencontrer des erreurs CORS si vous essayez d'accéder à des fichiers sur votre système de fichiers local avec JavaScript. Je recommanderais d'utiliser VS Code comme IDE et je recommanderais également d'installer l'extension du serveur VS Code en direct .

Le projet en direct est servi à partir de /app-main/public , vous devrez donc pointer un serveur en direct ici également. Pour faire ceci:

1. Accédez aux paramètres d'extension en direct dans le code vs en cliquant sur l'icône COG et en sélectionnant les «paramètres d'extension»

2. Cliquez sur 'Modifier dans Settings.json'

3. Définissez la racine sur: "liveServer.settings.root": "/app-main/public"

Vous pouvez maintenant exécuter le projet à l'aide de l'extension du serveur en direct en cliquant avec le bouton droit index.html et en sélectionnant «Ouvrir avec le serveur en direct».

Si vous n'êtes pas sûr, veuillez jeter un œil à la documentation.

Le code

HTML, CSS et JavaScript vivent actuellement dans le /app-main/public . Le JavaScript principal est situé dans index.js .

Contributif

Veuillez consulter contribution.md pour plus d'informations sur la façon de contribuer.