/minddoc-challenge

Primary LanguageJavaScript

MindDoc Challenge App

App Running on vercel

App achitecture

App architecture

Challenges and solutions

  • Different pagination strategy. Repositories and Search APIs have different pagination strategy. The first one uses since parameter that is essentialy repo id and the last one uses page parameter. Solution: pagination reducer is responsible for determination of pagination strategy and setting up page flag in pagination object. Pagination component acts based on page flag and call repos API or serach API accordingly. Search term (params) is saved in redux store and used by the serach repos actions to produce next / prev serach result.

  • Pagination prev. No prev link in response header for since pagination. Solution: create pagination history to record all passed chanks of repos.

  • GET /repositories API returns object with url but not a actual paramaters for most repos attributes (stars for example). Solution: use GET /repo/{user}/{name} call to get repo detail object when user is selected a repo.

  • 60 calls limits for not authorized app. Solution: only use GET /repo/{user}/{name} for selected repo. Promise.all(...) produce 403.

  • No sort option for GET /repositories call. Workaround / feature: sort and order is working only inside fetched chank of repos (100)

Bootstrapping

This project was bootstrapped with Create React App and then all generated files were deleted.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.