Servidor API para la aplicacion de CarShare desarrollada en en curso academico 2020/2021 para el CIFP Virgen de Gracia (Puertollano).
El proyecto ha sido realizado con:
Las siguientes intrucciones te ayudaran a tener el proyecto funcionando en tu maquina local.
El proyecto esta diseñado para su despliegue con Docker para que, al utilizar sus contendores el despliegue sea lo mas limpio y automatizado posible.
Para la instalación de Docker y su correcto funcionamiento puede acceder a Documentacion oficial de Docker. Ahi encontrar la instacion dependiende de su sistema operativo ademas de guias sobre el uso de Docker.
Para la instalación tendremos dos opciones:
La instalación de Git sera distinta dependiendo de nuestro sistema operativo: Windows y Mac cuentan con sus propios instaladores.
Instalador de Windows
Instalador de Mac
Para la instalación en Linux solo deberemos usar el siguiente comando en la terminal:
apt-get install git
Una vez instalado en nuestro sistema simplemente tendremos que abrir una terminar en la carpeta donde queramos tener el proyecto y ejecutra el siguiente comando:
git clone https://github.com/rnavas81/ServidorRuedas.git
A traves de los comandos de git podremos movernos los las ramas del repositorio.
git branch nombre_de_la_rama
Simplemente tendremos que ir a la parte superior de esta pagina y en el desplegable de code tendremos la opcion para descargar el proyecto en zip, despues solo nos quedara descomprimirlo en la carpeta que deseemos. Esto nos bajara el pryecto en la rama en la que nos situemos.
Para ello tendremos que realizar la instalacion de Docker:
Para Windows y Mac tendran sus propios instaladores que se encuentran en la Documentacion oficial de Docker.
Para Linux tendremos que realizar los siguientes comandos:
sudo apt-get update
sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io
Despues añadiremos el usuario para no tener que hacer sudo
sudo usermod -aG docker $USER
Instalaremos Docker Compose para el despliegue automatizado
sudo apt install docker-compose
Para el correcto despliegue automatizado el proyecto es acompañado por dos ficheros de scripts que deberemos de utilizar segun nuestro SO.
Para evitar problemas de persmisos recomendamos ejecutar estos scripts con permisos de administrador.
El conjunto de scripts levantara los Dockers necesarios para el despliegue del proyecto, ademas de que en la terminal iran pareciendo el proceso del depliegue ademas de las intrucciones.
- Rodrigo
- Jorge
- Alejandro
Si desea realizar alguna aportacion o corrección al codigo esta sera bien recibida atraves de un pull resquest
Este proyecto está bajo licencia MIT.
