Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carlogilmar committed Sep 22, 2019
1 parent 3f8e78e commit eb17ff7
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

# DEMO

**"Discover my project"** is about to get information from a *Repo URL*. The idea behind this is analize an Open Source project for know more about his development history and understand how this project was built. For this I tried to analize two information sources: the git data, and the github api. I want to build a platform for generate open source development process based on their version control history for learn more about how this developers are writting software.

![](guides/demo.gif)

## Setup
Expand Down Expand Up @@ -39,6 +41,17 @@ The main goal is explore an open source project through the git data and the git

![](guides/tres.png)

## Technical Design

The main flow is represented by the follow illustration:

![](guides/siete.png)

The main flow was wrote in `core.ex`:

![](guides/ocho.png)


## How the project works

Then to run the phoenix server, open `http://localhost:4000/`.
Expand Down Expand Up @@ -88,3 +101,7 @@ Features:
- Get commits frequency by month
- Generate the workflow chart for show the repo construction
- Analize the words used in commits vs words used in PR vs words used in issues
- Add railway pattern for validate errors when the api don't response
- Add more validations for get a valid url
- Accept more platforms: GitLab, etc...

Binary file added guides/ocho.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guides/siete.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit eb17ff7

Please sign in to comment.