manuelmejiaio / BriteCore-Insurance-System

BriteCore Insurance System

BriteCore-Insurance-System

Welcome to BriteCore Insurance System. The project's goal is to build in one week a system that be able to insurers define their own data model, and for that provide a fully tested API to make possible built any frontend system using it.

In summarize, this project was created using MySQL to create a dynamic data model, Django Restful framework for the backend API and the frontend was built using the modern javascript framework VueJS. Was created mainly two internal projects, one called by backend and another frontend, and both of then do the communication using the REST pattern. To Devops, was utilized Docker, Docker-compose and Amazon AWS to deploy it.

What was done

Data

Was created two data models, one that was implemented as a MVP ( Minimum Viable Product) and another to be the best approach, but consequently, would spend more time.

Here are (The MVP and the best approach): *(My personal bonus)

• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/model/Implemented%20MVP.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/model/Best%20approach%20model.jpeg

Backend

• The backend was built using the community best practices and TDD oriented, with that, the API was fully tested (around 50 tests!). The API was created using the framework Django 2.0 and python 3.6.

• The API is prepared to all http verbs / REST. It's means, anyone is able to request a full CRUD of risk types, risk, field types, fields and fields by risk. *(My personal bonus)

Here are a few localhost API screens:

• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/api/api_root_page.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/api/fields_by_risk_list.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/api/structure_documentation.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/api/api_interaction.jpeg

Frontend

• The frontend was built using the modern javascript framework Vuejs, HTML5, CSS3 / Sass.

• Was created three pages, one to make all CRUD API requests for Risk Types, one to simulate how create the riks and their fields (almost finished), and finally the main page, that get all risk fields and show them in a appropriate way. *(My personal bonus)

Here are a few frontend screens:

• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/system/welcome_page.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/system/risk_type_crud.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/system/manage_risks.jpeg
• https://github.com/geovanecomp/BriteCore-Insurance-System/blob/master/docs/system/main_screen.jpeg

Devops *(My personal mega bonus)

• The project was built using Docker and Docker-compose, with that anyone can make an easy and faster installation using these containers. With that, for example, was really easy up the application to AWS - Amazon Web Services.

How to execute a developer version

1. Download and install Docker (Version 3);
2. Download and install Docker-compose;
3. Clone this project;
4. From the project root folder execute to build and up the containers: docker-compose -f docker-compose.yml -f docker-compose.development.yml up --build;
5. Access the backend container and execute the script db_initialize.sh to populate the database: docker-compose -f docker-compose.yml -f docker-compose.development.yml exec backend bash -c "sh db_initialize.sh";
6. Access http://localhost:8080 to open the software or http://localhost:8000 to open the API documentation.
7. Finally, have fun =).

How to execute the production version (Temporary Off)

1. Just access: http://ec2-54-198-232-208.compute-1.amazonaws.com/

For questions, critiques or compliments, send me an email: [e-mail]