README.md

by CONTaFinTEAM

CONTaFin

In this repository we will place our web application, which helps students to learn contability and lets teachers to control them.

Team :

• Luis Caumel Morales:

  • E-mail: l.caumel@alumnos.urjc.es.
  • Github: Caumel.

• Lizeth Marcela de la Torre:

  • E-mail: lm.delatorre@alumnos.urjc.es.
  • Github: marceladb.

• Raul Velasco Rubio:

  • E-mail: r.velascor@alumnos.urjc.es.
  • Github: raulvr2.

• Jaime Morillo Leal:

  • E-mail: j.morillol@alumnos.urjc.es.
  • Github: Jaimemorillo.

• Alejendro Pinto Fernandez

  • E-mail: a.pinto@alumnos.urjc.es.
  • Github: AlejandroPinto.

Tools :

• Trello.
• Project.

About the project:

Topic

Website Contability-learning platform.

Database entities

- User:

	- Anonymous.
	- Student.
	- Teacher (administrator).
	
- Unit.
- Lesson.
- Exercise.
- Answer.

Advanced functionality

- Progress Statistics.
- Basic User Information.

Graphic information

We are going to use line graphics showing students information (days/hours).	

Other functionality

- Logging alternatives.
- Export to excel.
- Send e-mails.

Phase 2

Navigation Diagram:

index.html

login.html

home.html

profile.html

lessons.html

excerciseType1.html

excerciseType2.html

excerciseType3.html

excerciseType4.html

excerciseType5.html

excerciseType6.html

excerciseType7.html

completedLesson.html

continueLesson.html

Phase 3

Navigation Diagram:

index.html

index.html(2)

home.html

profile.html

configuration.html

addGoal.html

lessons.html

exercise.html

lessonCompleted.html

continueLesson.html

adminHome.html

usersData.html

unitCreation.html

Database diagram

Diagram with the entities of the database, its fields and the relationships between them.

Class and templates diagram

Classes

Templates

How to use

STS and MySL Workbench Configuration

Open the framework STS File -> Open Projects From Files System -> Directory... -> And we select the route where we keep the project Open MySQL Workbench Select a MySQL connection user curro be "root" and the password "pass" Once inside we will click on Create a new Schema in the connected server whose name will be "test" Start our application 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.

Configure IDE

• Download STS (http://spring.io/tools/sts/all).
• Import as a Maven project.
• Update Maven project.
• Run as a Spring Boot application.
• Go to https://localhost:8080
• Enjoy our application.

Anonymous users

As an anonymous user we can enter the application and perform the available lessons in addition to creating or entering our profile.

Registered users

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

Admin

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.

The application does not need more explanations since it is very intuitive because it is intended for teaching.

Phase 4

REST API documentation

Document Api documentation with information about the REST API.

Docker

Docker lets you to use our app in a very easy way without having anything install, you just need Docker. Read the Docker usage to know more.

Class and templates diagram

Phase 5

Angular documentation

Document Angular documentation with information about our work with Angular

Sonarqube documentation

Information

Documentation of Sonarqube on requirements, operations and guidelines on how to use it.

Guide

Sonarqube document that shows the steps to follow to develop the sonar analysis environment.

Selenium documentation

Information

Documentation of Selenium on requirements, operations and guidelines on how to use it.

Guide

Selenium Selenium start guide.