Github Search

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing

About The Project

Github repositories search application using Search API. It displays results after entering term.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• node version

  v18.12.0

Installation

1. Clone the repo

   git clone https://github.com/marimarimarietty/SearchApp.git

2. Install NPM packages

   npm install

(back to top)

Usage

Run the development server:

npm start

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

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)