GitHub Profile Finder

A tool that allows anyone to find GitHub users by his username.

About The Project

A simple tool that allows anyone to find GitHub users by his username.

Built With

This project was built with:

• Ruby on Rails
• Tailwind CSS
• sweetalert2

Extra:

• Profile Card Template

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is a list of the things you need to use the software.

• Ruby
• Rails cli
• nodejs
• yarn

Installation

1. Clone the repo

   git clone https://github.com/gentildpinto/gitfinder.git

2. Install gems with bundler

   bundle install

3. Install JavaScript packages with yarn

   yarn install

4. Run the project

   rails s

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gentil Pinto - @gentil__pinto - [email protected] - Linkedin