Code Monkey home page Code Monkey logo

backend-test-api-design's Introduction

TuringTech Technical Test / Backend API (Beginner -> Intermediate)

The goal of this test is to evaluate your ability:

  • to architecture a simple but reliable backend application,
  • to process data and compute metrics,
  • and to build a JSON API delivering these metrics.

Instructions

For an organisation of your choice on GitHub (that has public repositories like Airbnb https://github.com/airbnb) , you need to build an app that computes the number of monthly new contributors for each of those repositories, from the month of their creation until now.

A new contributor is someone who did a commit for the first time in a repository.

Homework

Build a straightforward application able to fetch data from GitHub API in a reliable and efficient way. You'll need to handle GitHub API errors and rate limit so that calls are retried properly.

Store the fetched data in a storage system of your choice (in-memory, filesystem, database, ...) and expose a HTTP JSON API delivering the results. The format of the API is the following (example with Facebook):

//GET /facebook/react/2019
{
    "org": "Facebook",
    "repository": "react", 
    "year": "2019",
    "newContributors": ...,
}

//GET /facebook/jest/2018
{
    "org": "Facebook",
    "repository": "jest", 
    "year": "2018",
    "newContributors": ...,
}
//GET /facebook/react/2019/06
{
    "org": "Facebook",
    "repository": "react",
    "year": "2019",
    "month": "06",
    "newContributors": ...,
}

//GET /facebook/jest/2018/03
{
    "org": "Facebook",
    "repository": "jest",
    "year": "2018",
    "month": "03",
    "newContributors": ...,
}

You can access the GitHub API using your personal GitHub account. There are many ways to retrieve the needed data, choose the most simple one, you do not need to handle more than what is required for the app.

Evaluation Criteria

  • Node best practices
  • Completeness: did you complete the features?
  • Correctness: does the functionality act in sensible, thought-out ways?
  • Maintainability: is it written in a clean, maintainable way?
  • Testing: is the system adequately tested?
  • Documentation: is the API well-documented?

Bonus

  • Use typescript
  • Use NestJS or any other node.js framework like Express/Fastify

Code Submit

Please organize, design, test and document your code as if it were going into production. Fork this repository and send us a pull request. We will review it and get back to you in order to talk about your code!

Feel free to apply! Drop us a line with your Linkedin/Github/Twitter/AnySocialProfileWhereYouAreActive at [email protected]

Questions

Please remember that the test has all the information you need to complete it, in case of confusion just make an assumption and move forward with your work.

All the best and happy coding.

backend-test-api-design's People

Contributors

turingtechpk avatar husnainqadri 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.