Skip to content
This repository has been archived by the owner on Jul 29, 2023. It is now read-only.

graphlab-fr/cosma-gui

Repository files navigation

Cosma DOI

(Texte en français plus bas)

Cosma is a document graph visualization tool. It modelizes interlinked Markdown files and renders them as an interactive network in a web interface.

Visit https://cosma.graphlab.fr/en/about/ to learn more about the project.

Installation

Cosma is available for macOS and Windows. Click here to access the latest release. The application is not signed with a security certificate, so you must have administrator privileges on your session to be able to run it.

macOS : download then unzip Cosma.app.zip in your Applications folder. For the first launch, right click the application and select Open.

Windows : download then unzip Cosma-win32-x64.zip. Rename the folder Cosma and place it in your C:\Programs or C:\Programs (86) folder.

All platforms: you can also download cosma-help.zip which contains sample records for you to test Cosma with. When first launching the application, visit Preferences and set Records directory to the cosma-help folder.

User documentation is online and updated periodically.

Development

Developing Cosma requires Node.js v16 or higher.

Run these commands :

# clone the repository
git clone --recurse-submodules https://github.com/graphlab-fr/cosma cosma
cd cosma
# install dependencies
npm i
# launch Cosma (Electron)
npm start

A draft of the developers' documentation is available in French: https://cosma.graphlab.fr/docs/manuel-developpement/

Build

Read the doc: https://www.electronforge.io/cli#make

npm run make
npm run make -- --platform (win32|darwin|linux) --arch (x64|arm64)

Find executables on /out/make/.


Cosma est un logiciel de visualisation de graphe documentaire. Il permet de représenter des notes interreliées sous la forme d’un réseau interactif dans une interface web.

Consultez https://cosma.graphlab.fr/a-propos/ pour plus d'informations sur le projet.

Installation

Cosma est disponible pour macOS et Windows. Visitez la page Releases pour obtenir la dernière version du logiciel. L'application n'est pas signée avec un certificat de sécurité, vous devez disposer des privilèges administrateurs sur votre session pour pouvoir l'exécuter.

macOS : téléchargez puis décompressez le fichier Cosma.app.zip et placez le le fichier Cosma.app dans ~/Applications. Au premier lancement, faites clic droit › Ouvrir sur l'application pour l'exécuter.

Windows : téléchargez puis décompressez le fichier Cosma-win32-x64.zip, renommez le dossier « Cosma » et placez-le dans C:\Programmes ou C:\Programmes (86).

Pour toutes les plateformes : vous pouvez également télécharger et décompresser le fichier cosma-fiches-aide.zip pour obtenir un répertoire cosma-fiches-aide contenant une documentation utilisateur sous forme de fiches. Ceci vous permet de tester le logiciel : au premier lancement de Cosma, indiquez le chemin du répertoire cosma-fiches-aides dans Préférences › Répertoire de fiches.

La documentation utilisateur est à jour et en ligne.

Développement

Pré-requis : Node.js version 16 ou supérieure.

Exécutez ces commandes :

# cloner le dépôt
git clone --recurse-submodules https://github.com/graphlab-fr/cosma cosma
cd cosma
# intaller les dépendances
npm i
# lancer Cosma (Electron)
npm start

Une ébauche de la documentation des développeurs est disponible : https://cosma.graphlab.fr/docs/manuel-developpement/