BoostNote App

Boost Note est un outil de gestion de projet basé sur des documents qui maximise la vitesse de l'équipe DevOps distante.

https://boostnote.io/

? Équipe principale (mainteneurs)

• ROKT33R
• Crosse au beurre
• Davy-C
• Komediruzecki

? Télécharger l'application

? Bureau

• ? Application Web (boostnote.io)
• ? macOS (.dmg)
• ? ️ Windows (.exe nsis)
• ? Linux (.deb)
• ? Linux (.rpm)

Mobile

• ? Application Web mobile (M.BoostNote.io)
• ? iOS (Apple App Store)
• ? Android (Google Play Store)

? Vous avez des problèmes?

Si vous ne savez pas comment utiliser l'application, veuillez créer une discussion sur notre page de discussion de questions / réponses.

Si vous trouvez un bogue, veuillez créer un problème pour notre suivi de GitHub Issue.

S'il est urgent ou privé, veuillez rejoindre notre chaîne Slack et envoyer un message direct à @ ROKT33R.

? Tu veux contribuer?

Si vous êtes intéressé par notre projet, vous pouvez participer à différentes manières.

• Partager votre idée
• Aider la communauté
• Résoudre les problèmes existants

Lisez notre guide de contribution, pour en savoir plus sur notre processus de développement, comment proposer des bugfix et des améliorations.

Partager votre idée

Pour améliorer l'application, nous avons besoin de votre idée! Il pourrait s'agir d'une nouvelle fonctionnalité ou d'une amélioration pour les fonctionnalités existantes. Si vous en avez, veuillez créer une discussion dans la catégorie des demandes de fonctionnalités.

Aider la communauté

Il existe de nombreuses façons d'aider notre communauté. Vous pouvez partager comment vous utilisez notre application en écrivant un article. Vous pouvez l'écrire dans la page de discussion générale, la communauté des développeurs externes (Dev.to ou Reddit) et votre blog si vous en avez un.

Vous pouvez également aider d'autres utilisateurs en répondant à leurs questions ici.

Résoudre les problèmes existants

Nous avons laissé l'étiquette "Help Wanted" à certains problèmes que les contributeurs externes pourraient essayer de résoudre. Certains d'entre eux pourraient avoir une petite générosité afin que vous puissiez en prendre une tasse de café après le piratage. Si vous trouvez des problèmes intéressants mais que leurs spécifications ne sont pas claires ou si vous ne savez pas comment les résoudre, veuillez laisser un commentaire sur les problèmes. Ensuite, nous vous donnerons plus d'instructions.

Développement

Actuellement, nous fournissons le code source Frontend uniquement afin que vous ne puissiez pas héberger notre serveur backend vous-même. Mais vous pouvez participer au développement via le mode Mock Backend. Bien qu'il ne couvre toujours pas encore toutes les API, vous pouvez accéder au dossier de base et à la gestion des documents.

Comment exécuter l'application

Créer un fichier .env.

NODE_ENV=development
MOCK_BACKEND=true

Exécutez des processeurs WebPack. Vous devez les exécuter dans des terminaux séparés.

npm run dev:cloud
# You can skip next two scripts if you don't need to run electron app.
npm run dev:electron
npm run dev:webpack

Comment étendre le backend simulé

Lorsque le mode est activé, tous les appels API seront passés à src/cloud/api/mock/mockHandler.ts .

Le code source est assez similaire à une interface de routeur. Tout ce dont vous avez besoin est method , pathname et une fonction de gestionnaire. Ainsi, lorsque vous confrontez une erreur Not Found lors de l'appel GET /api/something , vous pouvez simplement ajouter un itinéraire simulé comme ci-dessous.

 {
  method : 'get' ,
  pathname : 'api/something' ,
  handler : ( { search } ) : GetSomethingResponse => {
    return {
      ... something
    }
  } ,
}

Scripts

• Développement Scipts
  • npm run dev:cloud : Exécutez WebPack pour l'espace cloud
  • npm run dev:webpack : Exécutez WebPack pour le rendu de la fenêtre principale de l'application de bureau
  • npm run dev:electron : Exécutez WebPack pour le processeur principal de l'application de bureau
  • npm run dev:mobile : Exécutez WebPack pour l'application mobile
  • npm run lint : Vérifiez les erreurs de peluche
  • npm run format : essayez de corriger automatiquement les erreurs de peluche
  • npm test : Exécutez le script de test
  • npm run tsc : Vérifiez les erreurs de type
• Construire des scripts
  • npm run build:electron-production : Création des actifs pour l'application de bureau
  • npm run build:cloud-production : Build Asssets pour l'espace cloud
  • npm run build:mobile-production : Créer des actifs pour l'application mobile
  • npm start : Exécutez l'application de bureau avec des actifs prédéfinis
  • npm run meta : Préparez les métadonnées pour le bâtiment de l'application de bureau (générer un package.json pour le module d'électrons-build)
  • npm run prepack : Créez des installateurs d'applications de bureau sans signature
  • npm run release : Créez des installateurs d'applications de bureau pour la production et téléchargez-les sur GitHub

? Links

• Notes de libération
• Gazouillement
• Groupe de mou
• Augmentation de la laine
• Boostnote.next-local

⚖️ Licence

GPL-3.0 © 2016 - 2022 Boostio