Débuter avec Node & Kinvey

Ceci est un post rapide pour vous aider à être opérationnel avec un nouveau projet de nœud connecté à un backend Kinvey.

Créer un projet de nœud

Je crée beaucoup de projets de nœuds, certains voient même le jour, j'ai donc un script pour en créer un. J'ai eu l'idée de ce tweet de de Tierney Cyren et j'ai appris encore plus de ce post de Phil Nash .

npx pour utiliser un module npm, que nous l'ayons installé ou non. Premièrement, licence pour générer la licence MIT, gitignore pour récupérer un fichier Node.js .gitignore et pour générer le fichier . Contributor Covenant dans le répertoire de votre projet en utilisant votre email comme information de contact. Finalement, nous lançons npm init -y pour créer un fichier package.json pour le projet. Le drapeau -y ou - oui utilise les valeurs de défaut ou les configurations que vous pouvez définir à l'aide de npm.set .

 npm set init.author.email "exemple-utilisateur@exemple.com"
npm set init.author.name "exemple_utilisateur"
npm set init.license "MIT"

C'est ça! J'ai un raccourci dans mon fichier ~ / .bashrc pour pouvoir taper simplement node-project dans un répertoire vide et le tout tourne en arrière et initialise git ] dans le répertoire et effectue le premier commit. Nash l'explique en détail dans son post que j'ai énuméré ci-dessus. Voici à quoi ma fonction ressemble:

 function node-project {
  git init
  licence npx mit> LICENSE
  noeud npx gitignore
  npx covgen "$ (npm get init.author.email)"
  npm init -y
  git add.
  git commit -m 'initial commit'
}

vous pouvez consulter le dépôt de ce projet pour voir ce que nous avons jusqu'à présent.

Connexion à Kinvey

Maintenant que nous avons notre projet de base, nous pouvons le connecter à notre backend Kinvey. . Tout d’abord, nous voudrons installer le Kinvey SDK qui est un open source.

npm i kinvey-node-sdk

* Tant que vous utilisez une version mise à jour de npm, vous n'avez pas besoin d'utiliser le drapeau –save / -s pour enregistrer le module en tant que dépendance, il le fait automatiquement.

Une fois l'installation installée, il suffit d'inclure le SDK dans notre projet et d'initier Kinvey. avec la clé et le secret de notre projet. Lorsque vous créez un projet avec le guide Kinvey, vos informations s'affichent dans l'une des fenêtres contextuelles.

// app.js const Kinvey = require ('kinvey-node-sdk') Kinvey.init ({   appKey: 'kid_S16j3xVFN',   appSecret: 'e0a009c5a6f84949a8310e8c24ff2b7f' )

C'est le moyen très simple de se connecter à Kinvey. Vous pouvez également ajouter quelques lignes de code pour tester votre connexion. Ajoutez simplement ceci sous votre Kinvey.init :

 Kinvey.ping (). Then ((réponse) => {
  console.log (`Kinvey Ping Success! Response: $ {response.kinvey}`);
  }). catch ((error) => {
    console.log (`Kinvey Ping a échoué. Réponse: $ {error.description}`);
  });

Si vous obtenez Kinvey Ping Success! Réponse: bonjour tu es en or. Sinon, vous pouvez consulter la documentation ici pour vous aider à résoudre le problème.

Voici le commit qui contient tous les changements apportés jusqu'à présent.

Fun optionnel [[19659036] Idéalement, vous ne voulez utiliser aucune de vos clés et de vos secrets en ligne, je les mets donc toujours dans un fichier de configuration. Ensuite, j'ajoute ce fichier à ma liste .gitignore pour qu'il ne soit jamais poussé vers le haut.

 // config.js

const config = {
  kinvey: {
    appKey: 'kid_S16j3xVFN',
    appSecret: 'e0a009c5a6f84949a8310e8c24ff2b7f'
  }
}

module.exports = config;

Il ne nous reste plus qu'à passer cet objet config à la fonction Kinvey.init dans notre fichier app.js .

 // app .js

const Kinvey = require ('kinvey-node-sdk');
const config = require ('./ config');

Kinvey.init (config.kinvey);

Tellement concis! N'oubliez pas qu'il est important d'ajouter le fichier config.js à votre .gitignore si vous utilisez le contrôle de version. Mais bien sûr, vous êtes.

.gitignore

 ...
# config stuff
config.js

Pour vous assurer que votre fichier de configuration est ignoré. Exécutez le statut git et assurez-vous qu'il ne figure pas dans la liste avant de pousser votre code.

Ici est le commit qui montre les modifications plus un exemple de fichier de configuration.

Etapes suivantes

] Nous sommes tous mis en place! Assez facile, non? Que ferons-nous ensuite, de telles possibilités. Voici quelques ressources utiles pour vous aider dans votre travail de codage:

Quelle que soit la direction que vous choisissez, souvenez-vous que vous pouvez toujours nous contacter sur Twitter à l'adresse @Kinvey . Bonne codage ??‍?!