iigunchev / github-search-mvst Goto Github PK

The task is to display a GitHub user and their repositories and allow the user to filter through the repositories by name using a search bar. For the design I was inspired by the layout and colours of the Agrilution app => https://www.mvst.co/showcases/agrilution.

• Next.js
• TailwindCss
• Storybook
• Typescript

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Clone the repo

git clone https://github.com/iigunchev/github-search-mvst.git

Install NPM packages

npm install

Run de development server

npm run dev

Run the test suite

npm run test

Run storybook

npm run storybook

(back to top)

• Add Pagination to the search results
• Complete tests (integration and E2E)
• Migrate to the v4 GitHub API, which is built using GraphQL

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)