Glimpse is a simple web application that allows users to search for GitHub repositories using keywords and save them to a favorite repos list. The application uses the GitHub API to fetch the search results and display them to the user. Additionally, a lightweight external API server manages the favorites list.
- Nextjs 13+
- Typescript
- TailwindCSS
- HeadlessUI
- Jest
To install and run the application locally, follow these steps:
- Clone the repository to your local machine.
- Install the required dependencies by running
npm install. - Start the application by running
npm start. - Open your web browser and navigate to
http://localhost:3000.
OR via Docker
$ COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose build
$ docker-compose upNote: To use the search functionality you will need to provide a Github Access Token with the public repository scope.
Endpoints Available for fine-grain access tokens
GET /search/code
GET /search/commits
GET /search/issues
GET /search/labels
GET /search/repositories
GET /search/topics
GET /search/users
The Github access token is referenced from an .env file with the name: GITHUB_ACCESS_TOKEN
To use the application, enter a search term into the input field. The application will fetch the search results from the GitHub API and display them within the autocomplete. Select a result to add it to your list of favorite Github repositories.
Note: The max amount of favorite Github repositories is 10. To search for additional repositiories lower the current favorite repository number to a number lower than 10.
This project is licensed under the MIT License. See the LICENSE file for details.