Code Monkey home page Code Monkey logo

mvst-github-api-challenge's Introduction

MVST Github Search API Challenge

This repo is a sample Github Search API integration with NextJS/ReactJS.

Checkout Github Search on Vercel to try my implementation.

  • ✅ React with Typescript
  • ✅ Storybook integration
  • ✅ Deployed at Vercel -> best place to host NextJS :)
  • ✅ Documented code
  • ✅ Tests integrated in storybook

Run Locally

Clone the project

  git clone [email protected]:Antonwy/mvst-github-api-challenge.git

Go to the project directory

  cd mvst-github-api-challenge

Install dependencies

  npm install

Start the NextJS server

  npm run dev

Start the Storybook server

  npm run storybook

Run Tests

  npm run test-storybook

Lessons Learned

  • Learned Storybook
  • NextUI is probably not production ready :)
  • Framer motion needs much time for performance improvements

Future Improvements

  • Framer motion performance Improvements
  • Little bug fixes
  • Improve Safari performance and bugs

MVST Exercise Feedback

Task description was partially unclear.
For me it wasn't clear, if I should create a repo search for repos of one user or for all repositories on github.
Also regarding the expected UI design I wasn't sure if I need to create a mocked github account like in the video or just the search functionality like I did it.
And what means: "GitHub repositories are basically just a glorified list" ??

But in general, I liked the task very much because it was very open and you could show a wide range of your skills by using different plugins etc.

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.