📚 Github Explorer

Status: Finished

About • Tech Stack • Author • License

❓ About

📚 This simple project is a list of repositories from a Github user, where I get the data through the github API

💬 Pre-requisites

Before you begin, you will need to have the following tools installed on your machine:

Git, Node.js. In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

💿 Running the web application

# Clone this repository
$ git clone https://github.com/NiltonIzaguirres/github-explorer.git

# Access the project folder in your terminal
$ cd github-explorer

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev

# The application will open on the port: 8080 - go to http://localhost:8080

---

Tech Stack

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

Website (React + TypeScript)

• React Router Dom
• Sass

See the file package.json

---

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

---

Author

_{Nilton Izaguirres}

---

License

This project is under the license MIT.