Skip to content
This repository has been archived by the owner on Nov 22, 2019. It is now read-only.

UEAesperanto/REST-API

Repository files navigation

Esperanto HTTPS CircleCI codecov license

Datumbazo kaj REST-API de la Universala Esperanto-Asocio (UEA)

Ĉiuj kodoj kaj ĉiuj rajtoj ligitaj al ili ĉi tie apartenas al la Universala Esperanto-Asocio (UEA), 2017. Por pliaj detaloj pri kiel ĝi funkcias, vidu la vikion de tiu ĉi ujo.

Dependaĵoj

Por faciligi la instaladon, oni uzas la teknologion Docker. Do la unua paŝo estas instali Docker en via komputilo kaj lanĉi ĝin. Anglalingvaj instruoj pri kiel fari tion estas en tiu ligilo

Instalado

Kiam vi certigus ke Docker estas boninstalita, aliru al la dosierujo per Terminal (en Vindozo, prompt) kie vi elŝutis tiun ĉi kodon kaj tajpu:

docker-compose -f docker/compose/production.yaml up --build -d

Atentu ke ĝi verŝajne ne bone funkcios se en la dosierujo kiun vi enmetis la kodon estus bezonata havi superuzantajn permesojn (sudo), vi devas ebligi ke tio estu uzita sen superuzantaj permesoj.

Por certigi ke ĉio okazis bone, tajpu docker ps kaj devus aperi io kiel la jeno:

CREATED                       STATUS                  PORTS                              NAMES
10 minutes ago              Up 10 minutes       0.0.0.0:3000->3000/tcp   uea-api
10 minutes ago              Up 10 minutes       0.0.0.0:3306->3306/tcp  uea-datumbazo

Tio estas ĉio, vi jam povos aliri API je http://localhost:3000 kaj sekvi nian dokumentadon por lerni kiel uzi ĝin.

Testoj

Por ekzekuti la aŭtomatajn testojn, tajpu:

docker-compose -f docker/compose/test.yaml up --build -d

Por vidi la testojn, tajpu:

docker logs -f uea-api-test

Agordado

Dependante je kiel via datumbazo estas agordita, povas esti ke la REST-API ne plene funkcios, do necesas agordi tion en la dosiero config.js.

Malinstalado

Por malinstali, simple tajpu:

docker-compose down

Kaj forviŝu la dosierojn de la komputilo.

Kromaj Docker-komandoj, kiuj povas esti utilaj

  • docker logs -f uea-api-[dev/test]: Montras la konzolon de la API;
  • docker exec -it uea-datumbazo-[dev/test] bash sekvita de mysql -uroot -p"$MYSQL_ROOT_PASSWORD" uea: donas aliron al la shell de la datumbazo;

Aŭtoroj

La aŭtoroj de la kodoj estas la jenaj: