Plantilla de proyecto Back-end con la tecnología Spring5.
- Java
- Maven
- Spring
- Mongodb
- Situarse en una carpeta raíz donde se encuentran los proyectos, mediante la consola:
>cd %ruta-de-la-carpeta% - Clonar el repositorio, se visualizará el contenido de la rama por defecto:
>git clone https://github.com/miw-upm/???
- Import Project, y seleccionar la carpeta del proyecto
- Marcar Create Project from external model, elegir Maven
- Next … Finish
- Crear el proyecto
- Bajarse la plantilla (con todas las dependencias): https://github.com/miw-upm/template-spring5/blob/master/docs/template-spring5.zip
- Descomprimir en una carpeta llamada como el proyecto, y editar el pom.xml para cambiar el nombre del artefacto
- Importar la carpeta desde IntelliJ
- Crear repositorio
- Instalar Git CLI https://git-scm.com/download
- Desde consola, crear el repositorio local, con las ramas master y develop
>git init>git add --all>git commit -m "Initial template-spring5">git checkout –b develop
- Conectar con GitHub
- Crear el repositorio remoto en Github https://github.com
- Conectarlo con repositorio local
>git remote add origin <url-repository>>git push --all>git config credential.helper store
- Conectar con Travis-CI
- Crear una cuenta en Travis-CI https://travis-ci.org
- Activa el seguimiento del repositorio de GitHub
-> My Account>Settings
- Configurar el fichero .travis.yml
- Realizar push de la rama develop y comprobar que se ejecuta Travis-CI
>git push origin develop
- Conectar con Sonarcloud
- Crear una cuenta en Sonarcloud https://sonarcloud.io
- Obtener el ApiKey de Sonarcloud
-> My Account>Security
- Definir una variable de entorno: SONAR-ApiKey asociada al proyecto en Travis-CI
-> More options>Settings>Environment Variables
- Configurar .travis.yml con la conexión de Sonar
- mvn sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=<organization> -Dsonar.login=$SONAR
- Realizar push en develop y comprobar que se dispara Sonar adecuadamente
>git push origin develop
- Conectar con Heroku
- Crear una cuenta en Heroku https://www.heroku.com
- Definir en el proyecto un API con los correspondientes Tests
- Configurar para Swagger (Springfox) https://github.com/miw-upm/template-spring5/blob/master/src/main/java/es/upm/miw/config/SwaggerConfig.java
- Realizar push en la rama develop y comprobar que todo es correcto
>git push origin develop
- Instalar Heroku CLI https://devcenter.heroku.com/articles/heroku-cli#download-and-install
- Crear una cuenta en Heroku https://www.heroku.com
- Obtener el ApiKey de Heroku
-> Account settings>API Key
- Crear una variable de entorno: HEROKU-ApiKey asociada al proyecto en Travis-CI
-> More options>Settings>Environment Variables
- Configurar .travis.yml con el despliegue en Heroku
deploy:provider: herokuapi_key:secure: $HEROKU
- Realizar push en la rama master y comprobar que se despliega en Heroku adecuadamente
>git push origin master
- Comprobar los logs de Heroku a través de consola
>heroku login>heroku logs -app=myApp
- Conectar con MongoDB
- Instalar Mongodb y arrancar el motor https://www.mongodb.com/download-center/community
- Crear un API con acceso a BD con los test correspondientes
- Ejecutar en local para comprobar los test
- Configurar el .travis.yml con el servicio de mongoDB
services:- mongodb
- Realizar push en develop para comprobar que todo va bien
>git push origin develop
- Añadir en Heroku un add-ons de mLab. Con ello se crean las BD y Heroku define automáticamente la variable de entorno MONGODB_URI con la uri de la BD
-> project>Overview
- También, se podría crear una cuenta en mLab https://mlab.com y bbtener la URI de una base de datos. Para finalmente, crear una variable de entorno: MONGODB_URI asociada al proyecto en Heroku
-> project>Settings
- Configurar el fichero de propiedades con la uri de BD
spring.data.mongodb.uri=${MONGODB_URI}
- Realizar push en la rama master y comprobar que se despliega en Heroku adecuadamente con acceso a BD
>git push origin master
- Comprobar los logs de Heroku a través de consola
>heroku login>heroku logs -app=myApp