README.md

GitHub Favorites

Save your favorites GitHub users

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

🧑🏻‍💻 About the project

This is simple mobile app to save and list your favorites GitHub Users, using GitHub REST API.

I use CRNA to start this project.

Click here to access the app layout on Figma.

🚀 Technologies

Technologies that I used to develop this mobile client

• ReactJS
• React Native Unimodules
• TypeScript
• React Native
• React Navigation
• UnForm 💜
• Styled Components
• Axios
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Requirements

• You must have React Navite development environment
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/github-favorites.git && cd github-favorites

Follow the steps below

# Install the dependencies
$ yarn

# If you are going to emulate with android, run this command
# Be sure to have the emulator open
$ yarn android

# If you are going to emulate with ios, run this command
$ yarn ios

🤔 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 EliasGcf/github-favorites

Follow the steps below

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

# 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 Elias Gabriel 👋  See my linkedin