laurabeatris / github-explorer

Explore GitHub repositories - built with React.js and Styled Components.

---

📌 Table of Contents

• Features
• Installation
• Getting Started
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• Explore repositories
• Show repository details such as Issues and Pull Requests

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

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

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:LauraBeatris/github-explorer.git

Install dependencies

yarn install

Start development server

yarn dev

🐛 Issues

Feel free to file a new issue with a respective title and description on the GitHub Explorer repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2020 This project is under the MIT license.

Made with love by Laura Beatris 💜🚀