104 lines
8.5 KiB
Markdown
104 lines
8.5 KiB
Markdown
|
# Frontend Mentor - GitHub user search app
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Welcome! 👋
|
||
|
|
|
||
|
|
Thanks for purchasing this premium Frontend Mentor coding challenge.
|
||
|
|
|
||
|
|
[Frontend Mentor](https://www.frontendmentor.io) challenges help you improve your coding skills by building realistic projects. These premium challenges are perfect portfolio pieces, so please feel free to use what you create in your portfolio to show others.
|
||
|
|
|
||
|
|
**To do this challenge, you need a good understanding of HTML, CSS, and JavaScript.**
|
||
|
|
|
||
|
|
## The challenge
|
||
|
|
|
||
|
|
Your challenge is to build out this GitHub user search app using the [GitHub users API](https://docs.github.com/en/rest/reference/users#get-a-user) and get it looking as close to the design as possible.
|
||
|
|
|
||
|
|
You can use any tools you like to help you complete the challenge. So if you've got something you'd like to practice, feel free to give it a go.
|
||
|
|
|
||
|
|
Your 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-scheme` in CSS.
|
||
|
|
|
||
|
|
Want some support on the challenge? [Join our Slack community](https://www.frontendmentor.io/slack) and ask questions in the **#help** channel.
|
||
|
|
|
||
|
|
The GitHub users API endpoint is `https://api.github.com/users/:username`. So, if you wanted to search for the Octocat profile, you'd be able to make a request to `https://api.github.com/users/octocat`.
|
||
|
|
|
||
|
|
### Expected behaviour
|
||
|
|
|
||
|
|
- On first load, show the profile information for Octocat.
|
||
|
|
- Display an error message (as shown in the design) if no user is found when a new search is made.
|
||
|
|
- If a GitHub user hasn't added their name, show their username where the name would be without the `@` symbol and again below with the `@` symbol.
|
||
|
|
- If a GitHub user's bio is empty, show the text "This profile has no bio" with transparency added (as shown in the design). The lorem ipsum text in the designs shows how the bio should look when it is present.
|
||
|
|
- If any of the location, website, twitter, or company properties are empty, show the text "Not Available" with transparency added (as shown in the design).
|
||
|
|
- Website, twitter, and company information should all be links to those resources. For the company link, it should remove the `@` symbol and link to the company page on GitHub. For Octocat, with `@github` being returned for the company, this would lead to a URL of `https://github.com/github`.
|
||
|
|
|
||
|
|
## Where to find everything
|
||
|
|
|
||
|
|
Your task is to build out the project to the design file provided. We provide both Sketch and Figma versions of the design, so you can choose which tool you prefer to use. You can download the design file on the platform. **Please be sure not to share them with anyone else.** The design download comes with a `README.md` file as well to help you get set up.
|
||
|
|
|
||
|
|
All the required assets for this project are in the `/assets` folder. The assets are already exported for the correct screen size and optimized. Some images are reusable at multiple screen sizes. So if you don't see an image in a specific folder, it will typically be in another folder for that page.
|
||
|
|
|
||
|
|
The design system in the design file will give you more information about the various colors, fonts, and styles used in this project.
|
||
|
|
|
||
|
|
## Building your project
|
||
|
|
|
||
|
|
Feel free to use any workflow that you feel comfortable with. Below is a suggested process, but do not feel like you need to follow these steps:
|
||
|
|
|
||
|
|
1. Separate the `starter-code` from the rest of this project and rename it to something meaningful for you. Initialize the codebase as a public repository on [GitHub](https://github.com/). Creating a repo will make it easier to share your code with the community if you need help. If you're not sure how to do this, [have a read-through of this Try Git resource](https://try.github.io/). **⚠️ IMPORTANT ⚠️: There are already a couple of `.gitignore` files in this project. Please do not remove them or change the content of the files. If you create a brand new project, please use the `.gitignore` files provided in your new codebase. This is to avoid the accidental upload of the design files to GitHub. With these premium challenges, please be sure not to share the design files in your GitHub repo. Thanks!**
|
||
|
|
2. Configure your repository to publish your code to a web address. This will also be useful if you need some help during a challenge as you can share the URL for your project with your repo URL. There are a number of ways to do this, and we provide some recommendations below.
|
||
|
|
3. Look through the designs to start planning out how you'll tackle the project. This step is crucial to help you think ahead for CSS classes to create reusable styles.
|
||
|
|
4. Before adding any styles, structure your content with HTML. Writing your HTML first can help focus your attention on creating well-structured content.
|
||
|
|
5. Write out the base styles for your project, including general content styles, such as `font-family` and `font-size`.
|
||
|
|
6. Start adding styles to the top of the page and work down. Only move on to the next section once you're happy you've completed the area you're working on.
|
||
|
|
|
||
|
|
## Deploying your project
|
||
|
|
|
||
|
|
As mentioned above, there are many ways to host your project for free. Our recommend hosts are:
|
||
|
|
|
||
|
|
- [GitHub Pages](https://pages.github.com/)
|
||
|
|
- [Vercel](https://vercel.com/)
|
||
|
|
- [Netlify](https://www.netlify.com/)
|
||
|
|
|
||
|
|
You can host your site using one of these solutions or any of our other trusted providers. [Read more about our recommended and trusted hosts](https://medium.com/frontend-mentor/frontend-mentor-trusted-hosting-providers-bf000dfebe).
|
||
|
|
|
||
|
|
## Create a custom `README.md`
|
||
|
|
|
||
|
|
We strongly recommend overwriting this `README.md` with a custom one. We've provided a template inside the [`README-template.md`](./README-template.md) file in this starter code.
|
||
|
|
|
||
|
|
The template provides a guide for what to add. A custom `README` will help you explain your project and reflect on your learnings. Please feel free to edit our template as much as you like.
|
||
|
|
|
||
|
|
Once you've added your information to the template, delete this file and rename the `README-template.md` file to `README.md`. That will make it show up as your repository's README file.
|
||
|
|
|
||
|
|
## Submitting your solution
|
||
|
|
|
||
|
|
Submit your solution on the platform for the rest of the community to see. Follow our ["Complete guide to submitting solutions"](https://medium.com/frontend-mentor/a-complete-guide-to-submitting-solutions-on-frontend-mentor-ac6384162248) for tips on how to do this.
|
||
|
|
|
||
|
|
Remember, if you're looking for feedback on your solution, be sure to ask questions when submitting it. The more specific and detailed you are with your questions, the higher the chance you'll get valuable feedback from the community.
|
||
|
|
|
||
|
|
**⚠️ IMPORTANT ⚠️: With these premium challenges, please be sure not to upload the design files to GitHub when you're submitting to the platform and sharing it around. If you've created a brand new project, the easiest way to do that is to copy across the `.gitignore` provided in this starter project.**
|
||
|
|
|
||
|
|
## Sharing your solution
|
||
|
|
|
||
|
|
There are multiple places you can share your solution:
|
||
|
|
|
||
|
|
1. Share your solution page in the **#finished-projects** channel of the [Slack community](https://www.frontendmentor.io/slack).
|
||
|
|
2. Tweet [@frontendmentor](https://twitter.com/frontendmentor) and mention **@frontendmentor**, including the repo and live URLs in the tweet. We'd love to take a look at what you've built and help share it around.
|
||
|
|
3. Share your solution on other social channels like LinkedIn.
|
||
|
|
4. Blog about your experience building your project. Writing about your workflow, technical choices, and talking through your code is a brilliant way to reinforce what you've learned. Great platforms to write on are [dev.to](https://dev.to/), [Hashnode](https://hashnode.com/), and [CodeNewbie](https://community.codenewbie.org/).
|
||
|
|
|
||
|
|
We provide templates to help you share your solution once you've submitted it on the platform. Please do edit them and include specific questions when you're looking for feedback.
|
||
|
|
|
||
|
|
The more specific you are with your questions the more likely it is that another member of the community will give you feedback.
|
||
|
|
|
||
|
|
## Got feedback for us?
|
||
|
|
|
||
|
|
We love receiving feedback! We're always looking to improve our challenges and our platform. So if you have anything you'd like to mention, please email hi[at]frontendmentor[dot]io.
|
||
|
|
|
||
|
|
**Have fun building!** 🚀
|