This project is a React-based Single Page Application (SPA) for searching GitHub repositories. It uses React with TypeScript, and leverages the GitHub API for fetching repository data. The application also incorporates MobX for state management, with persistent storage in localStorage.
- Search Functionality: Search GitHub repositories based on various criteria like name, description, stars, followers, and language.
- Sort Options: Sort search results by the number of stars and forks.
- History Tracking: Track search history with the ability to view and clear past searches.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js
- npm (usually comes with Node.js)
-
Clone the repository:
git clone https://github.com/andreleon/github-search.git
-
Navigate to the project directory:
cd github-search -
Install dependencies:
npm install
-
Start the development server:
npm start
This runs the app in development mode. Open http://localhost:3000 to view it in the browser.
-
Build the app for production:
npm run build
This builds the app for production to the
buildfolder.
-
Run Prettier to format code:
npm run prettier-write
-
Check the code formatting with Prettier:
npm run prettier-check
TODO
Contributions are welcome. Please open an issue first to discuss what you would like to change, or directly open a pull request.
This project is licensed under the MIT License.
This project was bootstrapped with Create React App.