Commit f52fb1bd authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

maj README + Makefile

parent 540ad72e
Loading
Loading
Loading
Loading
+13 −12
Original line number Diff line number Diff line
TOOLS_DIR=tools/
HTTP_PORT=1234
install-basex: ## BaseX: Téléchargement, installation et définition du mot de passe admin
install-basex: # BaseX: Téléchargement, installation et définition du mot de passe admin
	@if [ -d 'basex' ]; then\
		echo 'BaseX install OK.';\
	else\
@@ -31,9 +31,6 @@ package: ## packaging de la version à distribuer
	@echo "Package ok"

#### end of dev targets
stop:  ## arrêt basex de dev
	./basex/bin/basexhttpstop || true

run:  stop ## lancement du serveur basex
	@if [ ! $(HTTP_PORT)  ]; then\
		./basex/bin/basexhttp -S;\
@@ -41,23 +38,27 @@ run: stop ## lancement du serveur basex
		./basex/bin/basexhttp -h$(HTTP_PORT) &\
	fi

stop:  ## arrêt basex de dev
	./basex/bin/basexhttpstop || true

install-tei-demo: run ## installation de l'édition de démo TEI
	sleep 2
	$(TOOLS_DIR)max.sh --d-tei
	@echo "done"

enable-plugin: ## Activation d'un plugin : make enable-plugin [plugin-name] [edition-name]
	cd $(TOOLS_DIR) && ./max.sh --$(MAKECMDGOALS)
install-ead-demo: run ## installation de l'édition de démo EAD
	sleep 2
	$(TOOLS_DIR)max.sh --d-ead
	@echo "done"

disable-plugin: ## Désactivation d'un plugin : make disable-plugin [plugin-name] [edition-name]
enable-plugin: ## activation d'un plugin : make enable-plugin [plugin-name] [edition-name]
	cd $(TOOLS_DIR) && ./max.sh --$(MAKECMDGOALS)

list-plugins: ## Affichage de la liste des plugins
disable-plugin: ## désactivation d'un plugin : make disable-plugin [plugin-name] [edition-name]
	cd $(TOOLS_DIR) && ./max.sh --$(MAKECMDGOALS)

package-edition:  ## packaging d'un max avec ses sources
	cd $(TOOLS_DIR) && ./build.sh
	@echo "Package ok"
list-plugins: ## affichage de la liste des plugins
	cd $(TOOLS_DIR) && ./max.sh --$(MAKECMDGOALS)

help: ## afficher l'aide
	@echo "\nChoisissez une commande. Les choix sont:\n"
+29 −30
Original line number Diff line number Diff line
@@ -22,51 +22,51 @@ Vous pouvez nous contacter via [contact.certic@unicaen.fr](mailto:contact.certic

- NodeJS (et npm) 10+

- BaseX 10.4+

## Installation

MaX propose un script pour initialiser votre environnement de développement, 
télécharger et installer les dépendances requises.

### Affichage de l'aide

```bash
$ make help
```

### Installation

```bash
$ cd </path/to/max>/tools

# Use global BaseX settings
$ ./max.sh -i

# set the env var $BASEX_PATH only if the basexclient command is not in your PATH. 
# Useless if basex was install with your system package manager
# The basex dir must contains the bin subfolder
$ export BASEX_PATH=</path/to/basex> 
$ ./max.sh -i

# you can also use local BaseX installation without setting any env var
$ ./max.sh -i -b </path/to/basex>

# move to your basex webapp folder 
$ cd </path/to/basex>/webapp
# create a symlink on your MaX instance
$ ln -s </path/to/max> .
# run basex http
$ cd </path/to/basex>/bin
$ ./basexhttp
$ make install
```
Vous pouvez vérifier votre installation sur http://localhost:8984/max.html

Cette étape vous demandera de saisir le mot de passe d'administration de BaseX de votre choix.

### Lancement du serveur

```bash
$ make run
```

Vous pouvez vérifier votre installation sur http://localhost:1234/max.html

### Éditions de démonstration

Pour l'édition TEI :
```bash
$ cd </path/to/max>/tools
$ make install-tei-demo
```

$ ./max.sh --d-tei
# or
$ ./max.sh --d-ead
Pour la version EAD :
```bash
$ make install-ead-demo
```

Ces installations nécessite la saisie du mot de passe défini lors du `make install`, l'utilisateur étant 'admin' par défaut.

Les éditions de démonstration sont consultables sur :
- http://localhost:8080/max_tei_demo/accueil.html (TEI)
- http://localhost:8080/max_ead_demo/accueil.html (EAD)
- http://localhost:1234/max_tei_demo/accueil.html (TEI)
- http://localhost:1234/max_ead_demo/accueil.html (EAD)

## Paramétrage et customisation

@@ -74,7 +74,6 @@ La documentation utilisateur est disponible [ici](https://pdn-certic.pages.unica




![UNICAEN-PDN-CERTIC](https://www.certic.unicaen.fr/ui/images/UNICAEN_PDN_CERTIC.png)

<img src="https://projet.biblissima.fr/sites/default/files/2021-11/biblissima-baseline-sombre-ia.png" alt="Biblissima" width="600px"/>
+2 −2
Original line number Diff line number Diff line
{
  "name": "MaX",
  "version": "1.1.0-rc3",
  "version": "1.1.0-rc4",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "MaX",
      "version": "1.1.0-rc3",
      "version": "1.1.0-rc4",
      "license": "CECILL",
      "dependencies": {
        "babel-polyfill": "^6.26.0",