|
1 |
| -# README |
| 1 | +# Tutor Virtual |
2 | 2 |
|
3 |
| -This README would normally document whatever steps are necessary to get the |
4 |
| -application up and running. |
| 3 | +[](https://codeclimate.com/github/ProyectoIntegrador2018/tutor_virtual/maintainability) |
5 | 4 |
|
6 |
| -Things you may want to cover: |
| 5 | +El sistema tiene como objetivo el automatizar los procesos que lleva a cabo nuestra cliente, Dora Elizabeth García Olivier, perteneciente del Centro Virtual de Aprendizajes. Dentro de sus actividades que actualmente realiza de manera manual se incluyen el: Dar de alta a alumnos, profesores y directivos asociados al servicio social Aprendizaje Verde. |
7 | 6 |
|
8 |
| -* Ruby version |
| 7 | +## Tabla de contenidos |
9 | 8 |
|
10 |
| -* System dependencies |
| 9 | +* TBD |
11 | 10 |
|
12 |
| -* Configuration |
| 11 | +## Detalles del Cliente |
13 | 12 |
|
14 |
| -* Database creation |
| 13 | +| Nombre | Email | Rol | |
| 14 | +| ------------------- | ------------------- | ---------------- | |
| 15 | +| Dora García Olivier | degolivier@itesm.mx | Coordinador CVA | |
15 | 16 |
|
16 |
| -* Database initialization |
17 | 17 |
|
18 |
| -* How to run the test suite |
| 18 | +## Ambientes del Sistema |
19 | 19 |
|
20 |
| -* Services (job queues, cache servers, search engines, etc.) |
| 20 | +* **Producción** - [TutorVirtual](http://tutorvirtual.herokuapp.com/) |
| 21 | +* **Desarrollo** - [Dev-TutorVirtual](http://dev-tutorvirtual.herokuapp.com/) |
21 | 22 |
|
22 |
| -* Deployment instructions |
| 23 | +Equipo: AD 2019 |
23 | 24 |
|
24 |
| -* ... |
| 25 | +| Nombre | Email | Rol | |
| 26 | +| ------------------ | ------------------ | ------------ | |
| 27 | +| Sergio Diaz | a01192313@itesm.mx | Scrum Master | |
| 28 | +| Patricio Forbes | A01192455@itesm.mx | PO Proxy | |
| 29 | +| Arturo González | A01193188@itesm.mx | Desarrollo | |
| 30 | + |
| 31 | +## Herramientas |
| 32 | + |
| 33 | +Pide acceso a las siguientes herramientas de no ser que no lo tengas: |
| 34 | + |
| 35 | +* [Github repo](https://github.com/ProyectoIntegrador2018/tutor_virtual) |
| 36 | +* [Backlog](https://github.com/ProyectoIntegrador2018/tutor_virtual/projects/2) |
| 37 | +* [Documentation](https://drive.google.com/drive/folders/16hcLTaW8YtWHzEUo9VfwR-Qjewcsap-G?usp=sharing) |
| 38 | + |
| 39 | +## Configuración del proyecto |
| 40 | + |
| 41 | +### Pre-condiciones |
| 42 | +- Install docker and docker-compose. |
| 43 | + |
| 44 | + |
| 45 | +### Build and Run |
| 46 | + |
| 47 | +EL siguiente comando usa un multi-stage build para usar compilaciones de |
| 48 | +varias etapas, y levantar la aplicación con un solo comando: |
| 49 | + |
| 50 | +``` |
| 51 | +docker-compose up web |
| 52 | +``` |
| 53 | + |
| 54 | +### Test |
| 55 | + |
| 56 | +EL siguiente comando usa un multi-stage build para usar compilaciones de |
| 57 | +varias etapas, y levantar la aplicación en el ambiente de ```test``` con un |
| 58 | +solo comando: |
| 59 | + |
| 60 | +``` |
| 61 | +docker-compose run --rm test bash |
| 62 | +``` |
| 63 | + |
| 64 | + |
| 65 | +El comando anterior construirá la imagen si no existe, llamada: `proyecto_integrador / tutor_virtual: development`. |
| 66 | + |
| 67 | +### Debbuging |
| 68 | +La estructura del proyecto permite a cualquiera ejecutar fácilmente una consola |
| 69 | +de bash para poder ejecutar cualquier tipo de instrucción. Por ejemplo algo como ```rails db:create```, ```rails db:migrate```, o ```rails db:seed``` |
| 70 | + |
| 71 | + |
| 72 | +``` |
| 73 | +docker-compose run --rm web bash |
| 74 | +``` |
| 75 | + |
| 76 | +### Pruebas |
| 77 | +Si se ejecuta ```rails db:seed```, se agregarán dos usuarios de prueba a la base |
| 78 | +de datos. Uno con permisos normales y otro con permisos de administrador. |
| 79 | +``` |
| 80 | +user: user@example.com |
| 81 | +password: 123456 |
| 82 | +
|
| 83 | +user: admin@example.com |
| 84 | +password: 123456 |
| 85 | +
|
| 86 | +``` |
| 87 | +## Stack Tecnológico |
| 88 | + |
| 89 | +### Librerías Front End: |
| 90 | +* Jquery |
| 91 | +* CSS |
| 92 | + |
| 93 | +### Librerías Back End: |
| 94 | + |
| 95 | +* Ruby on Rails |
0 commit comments