Skip to content

Commit

Permalink
README actualizado, close #52
Browse files Browse the repository at this point in the history
  • Loading branch information
mariasanzs committed Dec 12, 2020
1 parent ea99ab5 commit f66007d
Showing 1 changed file with 34 additions and 13 deletions.
47 changes: 34 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,57 @@ La idea del proyecto es poder enterarse rápidamente de descuentos, promociones

Puedes ver la justificación de por qué he elegido Sinatra como framework y documentación del uso de este [aquí](https://github.com/mariasanzs/makeupIV/blob/master/docs/sinatra.md)

Puedes ver como he diseñado la API y toda la documentación relativa a esta [aquí]()
Puedes ver como he diseñado la API y toda la documentación relativa a esta y a los test que se han realizado [aquí](https://github.com/mariasanzs/makeupIV/blob/master/docs/api.md#documentaci%C3%B3n-del-desarrollo-de-la-api)

Puedes ver como he generado un archivo log en el que se almacenan todos los registros de peticiones [aquí](https://github.com/mariasanzs/makeupIV/blob/master/docs/log.md#uso-de-middleware-para-creaci%C3%B3n-de-un-fichero-log)

Puedes instalar todas las dependencias haciendo `rake install` y pasar los test haciendo `rake test`. Puedes ver todas estas instrucciones (task) en el archivo [Rakefile](https://github.com/mariasanzs/makeupIV/blob/master/Rakefile)

También puedes iniciar el servicio haciendo `rackup`

## Enlaces a ficheros 📑

***🆕myapp.rb***
***🆕 iv.yaml***

Puedes consultar el fichero iv.yaml [aqui](https://github.com/mariasanzs/makeupIV/blob/master/iv.yaml)

***🆕 config.ru***

Puedes consultar el fichero iv.yaml [aqui](https://github.com/mariasanzs/makeupIV/blob/master/config.ru)


***🆕 sinatra/myapp.rb***

Puedes consultar el fichero myapp.rb en el que he desarrollado la gran mayoría de la API con Sinatra [aquí](https://github.com/mariasanzs/makeupIV/blob/master/sinatra/myapp.rb)

***🆕testMyapp.rb***
***🆕 src/almacen.rb***

Puedes consultar el fichero con todos los test del fichero myapp.rb [aqui](https://github.com/mariasanzs/makeupIV/blob/master/spec/testMyapp.rb)
Puedes consultar el fichero almacen.rb en el que han desarrollado funciones para la [HU08](https://github.com/mariasanzs/makeupIV/issues/53) y cuya clase actúa como una de las clases controladoras de la API [aquí](https://github.com/mariasanzs/makeupIV/blob/master/src/almacen.rb)

***🆕Código fuente***
***🆕 spec/testMyapp.rb***

Puedes acceder al código fuente del proyecto desde la carpeta [/src](https://github.com/mariasanzs/makeupIV/tree/master/src)
Puedes consultar el fichero con todos los test del fichero myapp.rb [aqui](https://github.com/mariasanzs/makeupIV/blob/master/spec/testMyapp.rb)

***🆕Ficheros de test***
***🆕 sinatra/log***

Todos los test están localizados en la carpeta [/spec](https://github.com/mariasanzs/makeupIV/tree/master/spec)
Puedes consultar la información recogida durante las peticiones a la api en el fichero [info.log](https://github.com/mariasanzs/makeupIV/blob/master/sinatra/log/info.log)

***🆕Ficheros de dependencias***
***🆕 Ficheros de dependencias***

Aquí se encuentran los ficheros [Gemfile](https://github.com/mariasanzs/makeupIV/blob/master/Gemfile) y [Gemfile.lock](https://github.com/mariasanzs/makeupIV/blob/master/Gemfile.lock). En Gemfile especificamos que gemas vamos a usar mientras que Gemfile.lock se encarga de mantener esas versiones actualizadas cuando corremos [Bundler](https://github.com/mariasanzs/makeupIV/blob/master/docs/bundler.md#bundler---gestor-de-dependencias).

***🆕Fichero de gestión de tareas***
***🆕 Fichero de gestión de tareas***

Aquí se encuentra el fichero [Rakefile](https://github.com/mariasanzs/makeupIV/blob/master/Rakefile) con el que podemos gestionar la tareas y automatizarlas con [Rake](https://github.com/mariasanzs/makeupIV/blob/master/docs/rake.md)

***Código fuente***

***iv.yaml***
Puedes acceder al código fuente del proyecto desde la carpeta [/src](https://github.com/mariasanzs/makeupIV/tree/master/src)

***Ficheros de test***

Todos los test están localizados en la carpeta [/spec](https://github.com/mariasanzs/makeupIV/tree/master/spec)

Puedes consultar el fichero iv.yaml [aqui](https://github.com/mariasanzs/makeupIV/blob/master/iv.yaml)

***5.json***

Expand All @@ -61,7 +80,9 @@ También puedes consultar la documentación del dockerfile y la justificación d

---
---

De hitos anteriores:
---
---

## Serverless

Expand Down

1 comment on commit f66007d

@vercel
Copy link

@vercel vercel bot commented on f66007d Dec 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.