Skip to content

Webapplication. Enable file generation from mustache templated file (backend part)

License

Notifications You must be signed in to change notification settings

vrenaudeau/hesperides

 
 

Repository files navigation

Hesperides Back

Hesperides is an open source tool generating content from a template file (using mustache) in a given environment.

Go to https://github.com/voyages-sncf-technologies/hesperides-gui to handle hesperides frontend.

❗ ❗ ❗

The project is currently being rework

See branch feature/springboot for the new version under construction

See branch master for the production version

❗ ❗ ❗

Installation

Pour lancer l'application sur un poste de dev, nous utilisons IntelliJ Ultimate Edition et les plugins suivants :

  • Maven
  • Kotlin
  • Lombok
  • Spring Boot, Data, MVC, Security
  • Spring Data, MVC, Security
  • Spring MVC, Security
  • Spring Security
  • Cucumber for Java

Vous pourrez alors lancer l'application avec les profils Spring noldap et fake_mongo.

Nous avons rencontré un problème qui empêche l'application de démarrer : le bouton Run se grise après avoir cliqué dessus sans que rien ne se passe. La seule solution que nous avons trouvée à l'heure actuelle est de désactiver tous les plugins d'IntelliJ, et de ne réactiver que ceux listés ci-dessus (en acceptant leurs dépendences).

Cela semble être un problème de compatibilité de plugins, espérons temporaire.

Requirements

  • Java 8 (openjdk, sun)

Choose between:

  • Docker (see docker-compose & Dockerfile files)

And :

  • MongoDB

Build

Build the whole project:

mvnw package

Build Docker image

docker build . -t hesperides/hesperides

Run

Some variables are set as environment variables:

  • SPRING_PROFILES_ACTIVE

  • LDAP_URL

  • LDAP_DOMAIN

  • LDAP_USER_SEARCH_BASE

  • LDAP_USERNAME_ATTRIBUTE

  • LDAP_CONNECT_TIMEOUT

  • LDAP_READ_TIMEOUT

  • MONGO_HOST

  • MONGO_PORT

  • SPRING_BOOT_ADMIN_URL

See boostrap/src/main/resources/application.yml

Run backend via Docker

docker-compose -f docker-compose-[BACKEND].yml up -d

Run backend manually

java -jar bootstrap/target/hesperides.jar

Run backend using Docker

docker run -d [-e ENV_VAR=ENV_VALUE] -p 8080:8080 --network hesperides_hesperides-network hesperides/hesperides

Run without ldap or mongodb

java -jar bootstrap/target/hesperides.jar -Dspring.profiles.active=noldap,fake_mongo

Documentation

Available online at https://voyages-sncf-technologies.github.io/hesperides-gui/

License

Hesperides is licensed under the GPL V3 license

Contributing

Do you have changes to contribute? Please see the CONTRIBUTING page. We are open to pull requests. Please first discuss your intentions via Issues.

This project includes a postman collection, check documentation/postman folder.

About

Webapplication. Enable file generation from mustache templated file (backend part)

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 94.6%
  • Gherkin 3.4%
  • Kotlin 1.5%
  • Other 0.5%