This is a solution to the GitHub user search app challenge on Frontend Mentor. Frontend Mentor challenges help you improve your coding skills by building realistic projects.
Note: Delete this note and update the table of contents based on what sections you keep.
Users should be able to:
- View the optimal layout for the app depending on their device's screen size
- See hover states for all interactive elements on the page
- Search for GitHub users by their username
- See relevant user information based on their search
- Switch between light and dark themes
- Bonus: Have the correct color scheme chosen for them based on their computer preferences. Hint: Research
prefers-color-schemein CSS.
- Solution URL: Github user search app
- Live Site URL: Add live site URL here
- Rails 7.0
- Tailwindcss
- Flexbox
- CSS Grid
- Mobile-first workflow
- VCR - Recording network requests
- Webmock - Mocking network requests
In the past I tried to make a component do all the requirements. However, you can also sometimes have two components with different effects and the composite of their actions can be complex. In this case I have two controllers one which toggles adding a class to the root of the page and another which toggles the visibility of elements on the page. They combine to make a light / dark color scheme toggle button.
- mode_switch_controller.js
- visibility_controller.js
Normally, a search page displays an index of items and your search filters it out. You
see the search action is embedded under the index action. However, this search is a
show action. I'm used to showing by #create and then #show the page. This causes a
lot of issues because you have to retain the API response data between the create and
show. The final solution was, obviously, to treat the show action like you would an
index action: just use the one action, show, and display any valid results.
Rails 5.1 introduced form_with, however, there's no good explanation in the Rails docs
about using it to search without an ActiveRecord model backend. There's a good stackoverflow answer covering it.
The Github API search has no database backend requirement. However, if you make the search
request a virtual model, via include ActiveModel::Model it gives flexibility on validation,
changing text of attributes using i18n.
When a search is simple you might get away with not needing a search-model but as it gets more complicated then a Search model makes the code cleaner. I did modeless search completed on this commit 9c2d29a before doing a model on this commit 8107dce.
Most straightforward way of getting authorized requests with Github API is with Personal Access Tokens. You can use them by adding them to the header of a request see below.
curl -i -H "Authorization: token ghp_pk6VP4xQYxdekLk16hAublcuhGu3ax2rOz3F" \
https://api.github.com/users/tenderloveUse this section to outline areas that you want to continue focusing on in future projects. These could be concepts you're still not completely comfortable with or techniques you found useful that you want to refine and perfect.
Note: Delete this note and the content within this section and replace with your own plans for continued development.
- Example resource 1 - This helped me for XYZ reason. I really liked this pattern and will use it going forward.
- Example resource 2 - This is an amazing article which helped me finally understand XYZ. I'd recommend it to anyone still learning this concept.
Note: Delete this note and replace the list above with resources that helped you during the challenge. These could come in handy for anyone viewing your solution or for yourself when you look back on this project in the future.
- Website - Add your name here
- Frontend Mentor - @yourusername
- Twitter - @yourusername
Note: Delete this note and add/remove/edit lines above based on what links you'd like to share.
- Show and Hide Elements With Rails 7's Stimulus One controller to handle all visibility issues.
