|
1 | | -***by CONTaFinTEAM*** |
2 | | -# CONTaFin |
3 | | -In this repository we will place our web application, which helps students to learn contability and lets teachers to control them. |
| 1 | +# ContaFin |
4 | 2 |
|
5 | | -[](https://www.youtube.com/watch?v=dd_GVtREpyg&feature=youtu.be) |
| 3 | +## Manual de instalación |
| 4 | +Requisitos del sistema para la correcta instalación de ContaFin: |
| 5 | +• Tener instalado en el entorno Docker. Se puede descargar desde [aquí](https://docs.docker.com/install/#supported-platforms). |
| 6 | +• Clonar el repositorio de Github. |
6 | 7 |
|
7 | | -## Team : |
| 8 | +Para hacer que se ejecute la aplicación solo hay que ir a la carpeta raíz del proyecto y ejecutar el siguiente comando: |
8 | 9 |
|
9 | | -- Luis Caumel Morales: |
10 | | - |
11 | | - - E-mail: l.caumel@alumnos.urjc.es. |
12 | | - - Github: [Caumel](https://github.com/Caumel). |
13 | | - |
14 | | -- Lizeth Marcela de la Torre: |
15 | | - |
16 | | - - E-mail: lm.delatorre@alumnos.urjc.es. |
17 | | - - Github: [marceladb](https://github.com/marceladb). |
18 | | - |
19 | | -- Raul Velasco Rubio: |
20 | | - |
21 | | - - E-mail: r.velascor@alumnos.urjc.es. |
22 | | - - Github: [raulvr2](https://github.com/raulvr2). |
23 | | - |
24 | | -- Jaime Morillo Leal: |
25 | | - |
26 | | - - E-mail: j.morillol@alumnos.urjc.es. |
27 | | - - Github: [Jaimemorillo](https://github.com/Jaimemorillo). |
28 | | - |
29 | | -- Alejendro Pinto Fernandez |
30 | | - |
31 | | - - E-mail: a.pinto@alumnos.urjc.es. |
32 | | - - Github: [AlejandroPinto](https://github.com/AMBushido). |
| 10 | + “docker-compose up”. |
33 | 11 |
|
34 | | -## Tools : |
35 | | - |
36 | | -- [Trello](https://trello.com/b/4dZpQcvA/desarrollo-de-aplicaciones-web). |
37 | | -- [Project](https://github.com/Caumel/DAW-G11-2018). |
38 | | - |
39 | | -## About the project: |
40 | | - |
41 | | -### Topic |
42 | | - Website Contability-learning platform. |
43 | | -### Database entities |
| 12 | +Para acabar la ejecución se debe introducir y ejecutar el comando: |
44 | 13 |
|
45 | | - - User: |
| 14 | + "docker-compose down". |
46 | 15 |
|
47 | | - - Anonymous. |
48 | | - - Student. |
49 | | - - Teacher (administrator). |
50 | | - |
51 | | - - Unit. |
52 | | - - Lesson. |
53 | | - - Exercise. |
54 | | - - Answer. |
55 | | - |
56 | | -### Advanced functionality |
| 16 | +Esto hará que la aplicación se inicie de forma escalonada empezando por la base de datos en el puerto 3306, el servidor en el puerto 8080 y el cliente en el puerto 4200. |
| 17 | +Para acceder a la aplicación se hará uso de un navegador web en el que se debe introducir la siguiente dirección: |
57 | 18 |
|
58 | | - - Progress Statistics. |
59 | | - - Basic User Information. |
| 19 | +http://localhost:4200/ |
60 | 20 |
|
61 | | -### Graphic information |
62 | | - We are going to use line graphics showing students information (days/hours). |
63 | | -### Other functionality |
64 | | - |
65 | | - - Logging alternatives. |
66 | | - - Export to excel. |
67 | | - - Send e-mails. |
68 | | - |
69 | | - |
70 | | -## Phase 2 |
71 | | -### Navigation Diagram: |
72 | | - |
73 | | -### index.html |
74 | | - |
75 | | -### login.html |
76 | | - |
77 | | -### home.html |
78 | | - |
79 | | -### profile.html |
80 | | - |
81 | | -### lessons.html |
82 | | - |
83 | | -### excerciseType1.html |
84 | | - |
85 | | -### excerciseType2.html |
86 | | - |
87 | | -### excerciseType3.html |
88 | | - |
89 | | -### excerciseType4.html |
90 | | - |
91 | | -### excerciseType5.html |
92 | | - |
93 | | -### excerciseType6.html |
94 | | - |
95 | | -### excerciseType7.html |
96 | | - |
97 | | -### completedLesson.html |
98 | | - |
99 | | -### continueLesson.html |
100 | | - |
101 | | - |
102 | | -## Phase 3 |
103 | | -### Navigation Diagram: |
104 | | - |
105 | | -### index.html |
106 | | - |
107 | | -### index.html(2) |
108 | | - |
109 | | -### home.html |
110 | | - |
111 | | -### profile.html |
112 | | - |
113 | | -### configuration.html |
114 | | - |
115 | | -### addGoal.html |
116 | | - |
117 | | -### lessons.html |
118 | | - |
119 | | -### exercise.html |
120 | | - |
121 | | -### lessonCompleted.html |
122 | | - |
123 | | -### continueLesson.html |
124 | | - |
125 | | -### adminHome.html |
126 | | - |
127 | | -### usersData.html |
128 | | - |
129 | | -### unitCreation.html |
130 | | - |
131 | | - |
132 | | -## Database diagram |
133 | | -### Diagram with the entities of the database, its fields and the relationships between them. |
134 | | - |
135 | | - |
136 | | -## Class and templates diagram |
137 | | -### Classes |
138 | | - |
139 | | - |
140 | | -### Templates |
141 | | - |
142 | | - |
143 | | -## How to use |
144 | | -### STS and MySL Workbench Configuration |
145 | | -Open the framework STS |
146 | | -File -> Open Projects From Files System -> Directory... -> And we select the route where we keep the project |
147 | | -Open MySQL Workbench |
148 | | -Select a MySQL connection user curro be "root" and the password "pass" |
149 | | -Once inside we will click on Create a new Schema in the connected server whose name will be "test" |
150 | | -Start our application |
151 | | -Once we have the connection of MySQL connected and the loaded project we will press in the Aplication.java of our application loaded in STS and we will Run as: Spring Boot App. |
152 | | -#### Configure IDE |
153 | | -- Download STS (http://spring.io/tools/sts/all). |
154 | | -- Import as a Maven project. |
155 | | -- Update Maven project. |
156 | | -- Run as a Spring Boot application. |
157 | | -- Go to https://localhost:8080 |
158 | | -- Enjoy our application. |
159 | | -### Anonymous users |
160 | | -As an anonymous user we can enter the application and perform the available lessons in addition to creating or entering our profile. |
161 | | -### Registered users |
162 | | -As registered users we can make the different lessons and progress in them, we can also see data about our profile as the level and our progress, we can also configure our account and set a goal to get an objective |
163 | | -### Admin |
164 | | -As administrators of our application you will get the same options with the application as other registered users but you can also view and export the users´ data and create new lessons. |
165 | | - |
166 | | -The application does not need more explanations since it is very intuitive because it is intended for teaching. |
167 | | - |
168 | | -## Phase 4 |
169 | | -### REST API documentation |
170 | | -Document [Api documentation](API.md) with information about the REST API. |
171 | | -### Docker |
172 | | -Docker lets you to use our app in a very easy way without having anything install, you just need Docker. |
173 | | -Read the [Docker usage](DOCKER.md) to know more. |
174 | | -### Class and templates diagram |
175 | | - |
176 | | - |
177 | | -## Phase 5 |
178 | | -## Angular documentation |
179 | | -Document [Angular documentation](AngularContafin/README.md) with information about our work with Angular |
180 | | - |
181 | | - |
| 21 | +## Manual de uso |
182 | 22 |
|
183 | | -## Sonarqube documentation |
184 | | -### Information |
185 | | -Documentation of [Sonarqube](https://docs.sonarqube.org/display/SONAR/Documentation) on requirements, operations and guidelines on how to use it. |
186 | | -### Guide |
187 | | -[Sonarqube](Sonar.md) document that shows the steps to follow to develop the sonar analysis environment. |
188 | | -## Selenium documentation |
189 | | -### Information |
190 | | -Documentation of [Selenium](https://www.seleniumhq.org/) on requirements, operations and guidelines on how to use it. |
191 | | -### Guide |
192 | | -[Selenium](Selenium.md) Selenium start guide. |
| 23 | +### Versión video |
| 24 | +[Video manual] (https://youtu.be/0_A530kgeZE) |
| 25 | +### Versión pdf |
| 26 | +[Manual PDF](https://github.com/Daniparri/DAW-G11-2018/Manual_de_uso.pdf) |
0 commit comments