/github-explorer-react

Github repos list from henbalmant

Primary LanguageJavaScriptMIT LicenseMIT

:octocat: Github Explorer

A friendly interface to navigate through Github repositories.

GitHub language count Repository size GitHub last commit License Stargazers Made by henbalmant Stargazers

Status: 🚀 Done

Summary

💻 About

:octocat: Github Explorer - is a friendly interface to navigate through Github repositories.

Project developed inside Ignite offered by Rocketseat.


⚙️ Features

  • List all repositories form a user: henbalmant
    • Names
    • Descriptions
    • URL

🚀 How to run this project

This project has only a frontend application.

Requirements

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, Yarn

Besides that, is good to have an editor to visualize and navigate trough the code like VSCode

🎲 Running the backend server

# Clone this repository
$ git clone git@github.com:henbalmant/github-explorer-react.git

# Access the project folder with your terminal/cmd
$ cd github-explorer-react

# Install all dependencies
$ yarn install

# Starts the development application
$ yarn dev

# The server will start on port:8080 - access http://localhost:8080 

🛠 Tech Stack

The following tools were used in the construction of the project:

Frontend (React + TypeScript)

See package.json

Utilities


💪 How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b my-feature
  3. Save your changes and create a commit message telling you what you did: git commit -m "feature: My new feature"
  4. Submit your changes: git push origin my-feature

If you have any questions check this guide on how to contribute


🦸 Author


Henrique Balmant
🚀

Gmail Badge Linkedin Badge


📝 License

This project is under the license MIT.

Made with ❤️ by Henrique Balmant 👋🏽 Get in touch!