Github Explorer - is a friendly interface to navigate through Github repositories.
Project developed inside Ignite offered by Rocketseat.
- List all repositories form a user:
henbalmant- Names
- Descriptions
- URL
This project has only a frontend application.
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
# 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
The following tools were used in the construction of the project:
Frontend (React + TypeScript)
See package.json
- Editor: Visual Studio Code
- Markdown: StackEdit, Markdown Emoji
- Commit Conventional: Commitlint
- API Testing: Insomnia
- Fork the project.
- Create a new branch with your changes:
git checkout -b my-feature - Save your changes and create a commit message telling you what you did:
git commit -m "feature: My new feature" - Submit your changes:
git push origin my-feature
If you have any questions check this guide on how to contribute
Henrique Balmant 🚀
This project is under the license MIT.
Made with ❤️ by Henrique Balmant 👋🏽 Get in touch!