Skip to content

Commit cd0b62d

Browse files
committed
imporoved the readme md file
1 parent a49dd9b commit cd0b62d

File tree

1 file changed

+0
-0
lines changed

1 file changed

+0
-0
lines changed

README.md

-7 Bytes

# React + TypeScript + Vite This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. Currently, two official plugins are available: - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh ## Expanding the ESLint configuration If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: ```js export default tseslint.config({ extends: [ // Remove ...tseslint.configs.recommended and replace with this ...tseslint.configs.recommendedTypeChecked, // Alternatively, use this for stricter rules ...tseslint.configs.strictTypeChecked, // Optionally, add this for stylistic rules ...tseslint.configs.stylisticTypeChecked, ], languageOptions: { // other options... parserOptions: { project: ['./tsconfig.node.json', './tsconfig.app.json'], tsconfigRootDir: import.meta.dirname, }, }, }) ``` You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules: ```js // eslint.config.js import reactX from 'eslint-plugin-react-x' import reactDom from 'eslint-plugin-react-dom' export default tseslint.config({ plugins: { // Add the react-x and react-dom plugins 'react-x': reactX, 'react-dom': reactDom, }, rules: { // other rules... // Enable its recommended typescript rules ...reactX.configs['recommended-typescript'].rules, ...reactDom.configs.recommended.rules, }, }) ``` # GitHub-Explorer-GEC # GitHub-Explorer-GEC # GitHub-Explorer-GEC

🌐 GitHub Explorer - React + TypeScript + Vite

A blazing-fast web application built with React, TypeScript, and Vite that showcases top GitHub repositories across various domains like Web Development, Machine Learning, Mobile Apps, DevOps, and more.

This project is designed with performance, scalability, and developer experience in mind, and comes with advanced ESLint configurations, Hot Module Replacement (HMR), and optional support for React SWC.


🚀 Features

  • ⚡️ Vite for lightning-fast development
  • 📦 TypeScript for type safety and DX
  • 🔥 HMR (Hot Module Replacement) with @vitejs/plugin-react or @vitejs/plugin-react-swc
  • 🧠 Fetch top repositories from GitHub based on stars, language, and domain
  • 💅 Clean and responsive UI
  • ESLint with strict, type-aware linting rules
  • 🧪 Easy to extend and test

📚 Domains Covered

  • Web Development
  • Machine Learning / AI
  • Mobile Apps
  • Blockchain
  • DevOps
  • Game Development
  • Data Science
  • IoT
  • Robotics
  • Security & Cryptography

🧰 Tech Stack

  • Frontend: React + TypeScript
  • Build Tool: Vite
  • Linting: ESLint + TypeScript strict configs
  • API: GitHub REST API v3
  • Styling: Tailwind CSS (optional)

🛠 Setup Instructions

  1. Clone the repository

    git clone https://github.com/your-username/github-explorer.git
    cd github-explorer
  2. Install dependencies

    npm install
  3. Run the development server

    npm run dev
  4. Build for production

    npm run build

🧑‍💻 Contributing

Contributions are welcome! Feel free to open issues or submit PRs to enhance functionality or fix bugs.

📝 License

This project is licensed under the MIT License.


🌟 Show your support

If you like this project, please consider giving it a ⭐ on GitHub!

0 commit comments

Comments
 (0)