Code Monkey home page Code Monkey logo

matrix-cargo-challenge's Introduction

Matrix Cargo Challenge developed by Italo Izaac ๐Ÿค˜

Overview

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.



Summary

Preview

Installing

1. Clone the repository:

$ git clone [email protected]:italoiz/matrix-cargo-challenge.git

2. Install dependencies:

If you use NPM, replace the yarn command by npm install.

$ cd matrix-cargo-challenge
$ yarn

3. Run the project:

Run the bellow command to startup the Backend and Frontend applications.

If you use NPM, replace the yarn dev command with npm 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

The API has only two routes, check below.

List Repositories

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 Languages

List all code languages from Github.

GET /languages

Response

[
  {
    "name": "Javascript"
  },
  {
    "name": "PHP"
  }
  ...
]

BUGs ๐Ÿ›

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.

Licence

MIT ยฉ Italo Izaac

matrix-cargo-challenge's People

Contributors

italoiz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.