franciscojunior10 / github-explorer

:computer: WebSite GitHub Explorer created in #GoStack12

WebSite GitHub Explorer:

The best way to search for profiles on GitHub!

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License   |    Author

About the project 📂:

This website provides the user with a search for GitHub users.

Users can view the profile and repositories of a user he has researched.

Technologies 🚀:

Technologies that I used to develop this WebSite

• ReactJS
• TypeScript
• React Router DOM
• Styled Components
• Polished
• React Icons
• Axios
• Eslint
• Prettier
• EditorConfig

Getting started 🖥️:

Clone the project and access the folder

$ https://github.com/franciscojunior10/github-explorer.git && cd github-explorer

Follow the steps below

# Install the dependencies
$ yarn

# Start the client
$ yarn start

How to contribute 🤔:

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork franciscojunior10/github-explorer

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd github-explorer

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

License 📝:

This project is licensed under the MIT License - see the LICENSE file for details.

---

Author 👨‍💻:

Made with ❤️ by franciscojunior10 meu 👉 Linkedin