-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #65 from mdelapenya/63-readme
- Loading branch information
Showing
2 changed files
with
28 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,22 +8,28 @@ Katanga es una aplicación opensource para ver los tiempos de los autobuses de | |
|
||
Puedes ver [la historia](http://www.latribunadetoledo.es/noticia.cfm/Local/20100523/katangas/circulan/facebook/C12146B3-B5AA-5333-3B488A78CFC4076A) de porqué en Toledo se llamaban katangas a los autobuses urbanos | ||
|
||
## Instalación | ||
## Instalación | ||
|
||
Clona este repositorio | ||
Baja la última [release](https://github.com/craftsmanship-toledo/katangapp-frontend/releases), o si tienes Docker en tu máquina, ejecuta el siguiente comando: | ||
|
||
```shell | ||
git clone [email protected]:craftsmanship-toledo/katangapp-frontend.git | ||
docker run -d -p 7777:80 craftsmanshiptoledo/katanga-frontend:1.0.0-rc.1 | ||
``` | ||
|
||
o baja la última [release](https://github.com/craftsmanship-toledo/katangapp-frontend/releases) | ||
Que levantará un contenedor con un servidor web Nginx con la aplicación de Katanga instalada, de modo que si abres un navegador en el puerto 7777 (http://localhost:7777) verás la aplicación funcionando. | ||
|
||
## Uso | ||
|
||
Puedes usar [Katanga](http://katanga.wedeploy.io/) Desktop que está hospedada en wedeploy. | ||
|
||
## Desarrollo | ||
|
||
Clona este repositorio | ||
|
||
```shell | ||
git clone [email protected]:craftsmanship-toledo/katangapp-frontend.git | ||
``` | ||
|
||
### Dependencias | ||
|
||
Instala [nodejs](https://nodejs.org/es/) para poder desarrollar o correr katanga. | ||
|
@@ -45,6 +51,16 @@ npm start | |
npm run build | ||
``` | ||
|
||
Este comando ejecutará un `npm install` así como invocará a `WebPack`. | ||
|
||
Si además queremos construir una imagen de Docker, podremos ejecutar: | ||
|
||
```shell | ||
npm run build-docker | ||
``` | ||
|
||
Este comando construirá una imagen bajo el repositorio `craftsmanshiptoledo/katanga-front`, con la versión indicada en el `package.json`, por ejemplo: `craftsmanshiptoledo/katanga-front:1.0.0-rc.1`. | ||
|
||
### No nos mires, únete | ||
|
||
Puedes unirte de muchas formas, no solo haciendo commits, puedes preguntar al equipo acerca de estas tareas, abrir un issue en el proyecto, mejorar nuestro código y hacernos peticiones para la inclusión de estas mejoras etc. | ||
|
@@ -55,9 +71,9 @@ Si te animas a hacer commits puedes ver su formato y sus convenciones [aquí](ht | |
|
||
| Pic | User | Github | Twitter | Web | | ||
| ---------------------------------------- | :-------------------: | :--------------------------------------: | :--------------------------------------: | :--------------------------------------: | | ||
| ![Javi](https://avatars3.githubusercontent.com/u/1202463?v=3&s=200) | Javier López de Ancos | [javierlopezdeancos](https://github.com/javierlopezdeancos) | [@javierland](https://twitter.com/javierland) | [javierlopez](http://public.javierlopezdeancos.wedeploy.io/) | | ||
| ![manuel](https://avatars2.githubusercontent.com/u/951580?v=3&s=200) | Manuel de la Peña | [mdelapenya](https://github.com/mdelapenya) | [@mdelapenya](https://twitter.com/mdelapenya) | | | ||
| ![Felix](https://avatars0.githubusercontent.com/u/4701534?v=3&s=200) | Felix Ortega | [felixortegam](https://github.com/felixortegam) | [@felixortegam](https://twitter.com/felixortegam) | | | ||
| ![Javi](https://avatars3.githubusercontent.com/u/1202463?v=3&s=100) | Javier López de Ancos | [javierlopezdeancos](https://github.com/javierlopezdeancos) | [@javierland](https://twitter.com/javierland) | [javierlopez](http://public.javierlopezdeancos.wedeploy.io/) | | ||
| ![manuel](https://avatars2.githubusercontent.com/u/951580?v=3&s=100) | Manuel de la Peña | [mdelapenya](https://github.com/mdelapenya) | [@mdelapenya](https://twitter.com/mdelapenya) | | | ||
| ![Felix](https://avatars0.githubusercontent.com/u/4701534?v=3&s=100) | Felix Ortega | [felixortegam](https://github.com/felixortegam) | [@felixortegam](https://twitter.com/felixortegam) | | | ||
|
||
|
||
|