rincon10/arep-seminario

Backend AREP

Check the Front-end implementation.

What is this?

This is a repository for all the files used to create a backend with flask in order to connect our functions with a simple JavaScript web application

Getting Started

For implementing this library you will need to have Python installed in your computer.

Prerequisites

To use this library you will need to have Python installed in your computer, at least the version 3.7.
You can check your Python version typing on cmd:

python --version

Installing

• Clone this git repository into your computer.
• Start coding!

# In your root folder:

https://github.com/Rincon10/AREP-Seminario.git

upgrade pip

python -m pip install --upgrade pip

install virtualenv

pip install virtualenv

Execute virtualenv

virtualenv .

Using the Virtual Environment

Activate:

cd venv/Scripts
activate

Deactivate:

cd venv/Scripts
deactivate

Install requirements:

• With the venv activated:

pip install -r requirements.txt

API

PUT REQUESTS

• [/api/v1/file]: Here you will find the functionallity based on the FileAnalyzer algorythm. The JSON structure of a PUT request to this endpoint should look like this:

{
	"nameProject": {
		"title": "Nombre del proyecto",
		"value": "SAOKO-back"
	},
	"authors": {
		"title": "Autores",
		"value": ""
	},
	"totalLines": {
		"title": "Total de líneas de codigo",
		"value": 1034
	},
	"totalClasses": {
		"title": "Total de clases",
		"value": 28
	},
	"controllers": {
		"title": "Total de controladores",
		"value": "ChatAPIController.java, RoomAPIController.java, TaskAPIController.java, UserAPIController.java"
	},
	"services": {
		"title": "Total de servicios",
		"value": "ChatService.java, RoomService.java, TaskService.java, UserService.java"
	},
	"microServicesSuggested": {
		"title": "Número de los microservicios sugeridos",
		"value": "chat, room, task, user"
	}
}

Testing the enpoint

1. Using

{
    "url":"https://github.com/juancho20sp/SAOKO-back.git"
}

Request

Back-end Response

Front-end Response

2. Using the repository

{
    "url":"https://github.com/Rincon10/U-Cord.git"
}

Request

Back-end Response

Front-end Response

Built With

• Python 3.8 - As the main programming language and Flask as microframework.

Author

• Juan David Murillo - Github
• Iván Camilo Rincón - Github
• Leonardo Galeano - Github
• Laura Garcia - Github

License

This is an open source project.

Thanks for checking out!