Github Search

A Vue 3/Nuxt 3 app leveraging the Github API, where users can search for Github repositories. Based on their search query, a list of matching repositories is rendered. By default, the home page shows repositories matching the word Random. Users can also view details of a specific repository, including the repository owner's username, creation date, and other activity data such as the number of forks, stars, and issues.

Github Actions CI Badges

Vercel Deployment

• https://github-search-nuxt.vercel.app/

Project setup

• git clone [email protected]:chokonaira/github-search.git
• Generate Github personal access token
• create a .env and add it as NUXT_GITHUB_ACCESS_TOKEN
• yarn install
• yarn dev

Run unit tests

• yarn run test

Run the dev server

• yarn dev

Lints and fixes files

• yarn lint

Website Routes

Search repositories page:

• /: Users can search for repositories by entering a keyword.

Repository details page

• /repo-details/:owner/:repo: View details of a specific repository.

Core Technology & Tools

• Scaffolding: Nuxt 3
• • Vue 3: Fully migrated to Vue 3 with Composition API.
• State Management: Pinia replaces Vuex for simpler, more efficient state management.
• Routing: Vue Router integrated via Nuxt's file-based routing.
• UI Library: Vuetify for material design components, replacing Bulma.
• Charts: Vue3-Charts for visualizing repository data (forks, stars, etc.).

Testing**

Unit Testing: Vitest with Vue Test Utils for testing components and state.

DevOps - CI/CD

Continuous Integration: Github Actions for automated testing and deployments.