A simple github repository explorer
About the project | Technologies | Getting started | How to contribute | License
👨🏻💻 About the project
This small web application was developed in order to study the main concepts of ReactJS. In a simple way, it allows registering and listing repositories, in addition to providing some information about it.
I made the deploy on GitHub Pages, access 📲
🚀 Technologies
Technologies that I used to develop this web application
- ReactJS
- TypeScript
- React Router DOM
- React Icons
- Styled Components
- Axios
- Eslint
- Prettier
- EditorConfig
💻 Getting started
Requirements
Clone the project and access the folder
$ git clone https://github.com/danilosales/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 danilosales/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.
Made with 💜 by Danilo Sales 👋 See my linkedin