Giter Club home page Giter Club logo

github-search's Introduction

GitHub Search

This is another search engine to read GitHub users information

Features

Enter GitHub username and search users matching the input like Google Search, click avatars to view more details, including repositories, followers and following.

Pages include:

  • HomePage / - A search bar to find users
  • UserPage /user/[username] - User information on GitHub, currently showing at most 100 items in repositories, followers & following.

Tech Stack

Prerequisite

Current local version:

Requirements

  • Node.js: 14.4 (version above v12 should be ok)
  • npm: v6.14

Optional

After cloning the repository, please copy the sample env .env.local.sample and change it to .env.local, then update GitHub Access Token

(More info can be found here)

cp .env.local.sample .env.local

Getting Started

First, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Production

First bundle and build the application:

npm run build

After a successful build, run the production server:

npm run start

Open http://localhost:3000 with your browser to see the result.

Deployment

For better performance and persistency, we can use Redis in docker-compose by updating .env.local

ENABLE_REDIS=true
REDIS_HOST=redis

Build and start the services by

docker-compose build
docker-compose up -d

github-search's People

Contributors

howard86 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.