This repository's a monorepo that contains the Backend and Frontend application was used Typescript in both environments, in the Backend was used simple Express application, and, in the Frontend was used React to build a simple interface to use the Backend API.
$ git clone [email protected]:italoiz/matrix-cargo-challenge.git
If you use NPM, replace the
yarn
command bynpm install
.
$ cd matrix-cargo-challenge
$ yarn
Run the bellow command to startup the Backend and Frontend applications.
If you use NPM, replace the
yarn dev
command withnpm run dev
.
$ yarn dev
This command will be running two processes, the Backend, and the Frontend. The backend will be available
on http://localhost:3000
and the frontend will be available on the http://localhost:4000
. ๐
The API has only two routes, check below.
Return an list of repositories from Github.
GET /repositories
Parameters
Name | Type | Description |
---|---|---|
lang |
string |
Filter repository by language. |
Response
[
{
"id": 69899,
"name": "ttfunk",
"full_name": "prawnpdf/ttfunk",
"description": "Font Metrics Parser for Prawn",
"html_url": "https://github.com/prawnpdf/ttfunk",
"owner": {
"id": 1440292,
"login": "prawnpdf",
"avatar_url": "https://avatars0.githubusercontent.com/u/1440292?v=4"
}
}
...
]
List all code languages from Github.
GET /languages
Response
[
{
"name": "Javascript"
},
{
"name": "PHP"
}
...
]
This is a "challenge project", if you detect some bug and would like to contribute, I will go very happy to learn with your contribution.
MIT ยฉ Italo Izaac