A better way to manage your favorite repositories.
GitHub Buddy is an app created with Ruby on Rails and is currently hosted on Heroku. The goal of this project is to provide users with an easier way organize their favorite repos and stay up to date with the latest releases. On a personal note, this project will serve as a deep exploration of rails and webpack for myself while building something I believe people may find useful! The eventual goal is allow folks to contribute to this project and suggest features that will enhance the overall user experience.
Before getting started please take a moment to review our code of conduct.
This application currently uses Rails 6.1.3.1 and Ruby 3.0.1. To contribute please fork this repo and then clone it to your local machine.
To get your dev environment setup please make sure you have all of the following:
For this project you will need to have PostgreSQL installed. There are a number of ways to do this but the most straight forward is to just download it from their website here. The most recent version should work fine.
If you're not familiar with working with PostgreSQL you may also find it handy to install Postico, but this is not required.
Rails 6 applications require that you have yarn and node.js installed.
You can find installation instructions for node at the Node.js website and then run this command to make sure it's installed correctly.
$ node --version
Per the rails docs, you will need to make sure your node.js version is greater than 8.16.0
You can find installation instructions for yarn at the Yarn website and then run this command to make sure it's installed correctly.
$ yarn -v
My preferred way to manage different ruby versions is with rbenv. To install rbenv follow the installation instructions from the rbenv repo
After you have installed rbenv you can restart your terminal and install ruby! Fair warning this will take about 10-15 minutes so maybe get up and go for a walk, or grab something to eat!
$ rbenv install 3.0.1
After you have installed ruby you can cd into the githubbuddy project directory on you local machine and run
$ rbenv local 3.0.1
If you run $ rbenv version you should see that 3.0.1 is set as the local version!
Finally, you will need to install bundler
$ gem install bundler
And then you can install all the dependencies
$ bundle install
If everything went well you should be able to run this command $ rails server, navigate to http://localhost:3000, and see the application running locally!