Github Explorer

A simple app made to study react using github api.
Report Bug · Request Feature

Table of Contents

1. Built With
2. Getting Started
   • Installation
3. Contributing
4. License
5. Acknowledgements

Built With

• React
• TypeScript
• Github API

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/artursantiago/github-explorer.git

2. Install packages

   yarn

3. Run the local development server

   yarn start

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• Polished
• React Icons

This project is only for study purposes. The brand, logo and name are non professional.