Skip to content

Commit 6976be8

Browse files
authored
Update README.md
1 parent f39f34f commit 6976be8

File tree

1 file changed

+71
-48
lines changed

1 file changed

+71
-48
lines changed

README.md

+71-48
Original file line numberDiff line numberDiff line change
@@ -2,90 +2,113 @@
22

33
![Design preview for the Social proof section coding challenge](./design/desktop-preview.jpg)
44

5-
## Welcome! 👋
5+
# Frontend Mentor - Social proof section solution
66

7-
Thanks for checking out this front-end coding challenge.
7+
This is a solution to the [Social proof section challenge on Frontend Mentor](https://www.frontendmentor.io/challenges/social-proof-section-6e0qTv_bA). Frontend Mentor challenges help you improve your coding skills by building realistic projects.
88

9-
[Frontend Mentor](https://www.frontendmentor.io) challenges help you improve your coding skills by building realistic projects.
9+
## Table of contents
1010

11-
**To do this challenge, you need a basic understanding of HTML and CSS.**
11+
- [Overview](#overview)
12+
- [The challenge](#the-challenge)
13+
- [Screenshot](#screenshot)
14+
- [Links](#links)
15+
- [My process](#my-process)
16+
- [Built with](#built-with)
17+
- [What I learned](#what-i-learned)
18+
- [Continued development](#continued-development)
19+
- [Useful resources](#useful-resources)
20+
- [Author](#author)
21+
- [Acknowledgments](#acknowledgments)
1222

13-
## The challenge
23+
**Note: Delete this note and update the table of contents based on what sections you keep.**
1424

15-
Your challenge is to build out this social proof section and get it looking as close to the design as possible.
25+
## Overview
1626

17-
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.
27+
### The challenge
1828

19-
Your users should be able to:
29+
Users should be able to:
2030

2131
- View the optimal layout for the section depending on their device's screen size
2232

23-
Want some support on the challenge? [Join our community](https://www.frontendmentor.io/community) and ask questions in the **#help** channel.
33+
### Screenshot
2434

25-
## Where to find everything
35+
![](./screenshot.jpg)
2636

27-
Your task is to build out the project to the designs inside the `/design` folder. You will find both a mobile and a desktop version of the design.
37+
Add a screenshot of your solution. The easiest way to do this is to use Firefox to view your project, right-click the page and select "Take a Screenshot". You can choose either a full-height screenshot or a cropped one based on how long the page is. If it's very long, it might be best to crop it.
2838

29-
The designs are in JPG static format. Using JPGs will mean that you'll need to use your best judgment for styles such as `font-size`, `padding` and `margin`.
39+
Alternatively, you can use a tool like [FireShot](https://getfireshot.com/) to take the screenshot. FireShot has a free option, so you don't need to purchase it.
3040

31-
If you would like the design files (we provide Sketch & Figma versions) to inspect the design in more detail, you can [subscribe as a PRO member](https://www.frontendmentor.io/pro).
41+
Then crop/optimize/edit your image however you like, add it to your project, and update the file path in the image above.
3242

33-
You will find all the required assets in the `/images` folder. The assets are already optimized.
43+
**Note: Delete this note and the paragraphs above when you add your screenshot. If you prefer not to add a screenshot, feel free to remove this entire section.**
3444

35-
There is also a `style-guide.md` file containing the information you'll need, such as color palette and fonts.
45+
### Links
3646

37-
## Building your project
47+
- Solution URL: [Add solution URL here](https://your-solution-url.com)
48+
- Live Site URL: [Add live site URL here](https://your-live-site-url.com)
3849

39-
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:
50+
## My process
4051

41-
1. Initialize your project 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/).
42-
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.
43-
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.
44-
4. Before adding any styles, structure your content with HTML. Writing your HTML first can help focus your attention on creating well-structured content.
45-
5. Write out the base styles for your project, including general content styles, such as `font-family` and `font-size`.
46-
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.
52+
### Built with
4753

48-
## Deploying your project
54+
- Semantic HTML5 markup
55+
- CSS custom properties
56+
- Flexbox
57+
- CSS Grid
58+
- Mobile-first workflow
59+
- [React](https://reactjs.org/) - JS library
60+
- [Next.js](https://nextjs.org/) - React framework
61+
- [Styled Components](https://styled-components.com/) - For styles
4962

50-
As mentioned above, there are many ways to host your project for free. Our recommended hosts are:
63+
**Note: These are just examples. Delete this note and replace the list above with your own choices**
5164

52-
- [GitHub Pages](https://pages.github.com/)
53-
- [Vercel](https://vercel.com/)
54-
- [Netlify](https://www.netlify.com/)
65+
### What I learned
5566

56-
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).
67+
Use this section to recap over some of your major learnings while working through this project. Writing these out and providing code samples of areas you want to highlight is a great way to reinforce your own knowledge.
5768

58-
## Create a custom `README.md`
69+
To see how you can add code snippets, see below:
5970

60-
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.
71+
```html
72+
<h1>Some HTML code I'm proud of</h1>
73+
```
74+
```css
75+
.proud-of-this-css {
76+
color: papayawhip;
77+
}
78+
```
79+
```js
80+
const proudOfThisFunc = () => {
81+
console.log('🎉')
82+
}
83+
```
6184

62-
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.
85+
If you want more help with writing markdown, we'd recommend checking out [The Markdown Guide](https://www.markdownguide.org/) to learn more.
6386

64-
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.
87+
**Note: Delete this note and the content within this section and replace with your own learnings.**
6588

66-
## Submitting your solution
89+
### Continued development
6790

68-
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.
91+
Use 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.
6992

70-
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.
93+
**Note: Delete this note and the content within this section and replace with your own plans for continued development.**
7194

72-
## Sharing your solution
95+
### Useful resources
7396

74-
There are multiple places you can share your solution:
97+
- [Example resource 1](https://www.example.com) - This helped me for XYZ reason. I really liked this pattern and will use it going forward.
98+
- [Example resource 2](https://www.example.com) - This is an amazing article which helped me finally understand XYZ. I'd recommend it to anyone still learning this concept.
7599

76-
1. Share your solution page in the **#finished-projects** channel of the [community](https://www.frontendmentor.io/community).
77-
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.
78-
3. Share your solution on other social channels like LinkedIn.
79-
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/).
100+
**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.**
80101

81-
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.
102+
## Author
82103

83-
The more specific you are with your questions the more likely it is that another member of the community will give you feedback.
104+
- Website - [Add your name here](https://www.your-site.com)
105+
- Frontend Mentor - [@yourusername](https://www.frontendmentor.io/profile/yourusername)
106+
- Twitter - [@yourusername](https://www.twitter.com/yourusername)
84107

85-
## Got feedback for us?
108+
**Note: Delete this note and add/remove/edit lines above based on what links you'd like to share.**
86109

87-
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.
110+
## Acknowledgments
88111

89-
This challenge is completely free. Please share it with anyone who will find it useful for practice.
112+
This is where you can give a hat tip to anyone who helped you out on this project. Perhaps you worked in a team or got some inspiration from someone else's solution. This is the perfect place to give them some credit.
90113

91-
**Have fun building!** 🚀
114+
**Note: Delete this note and edit this section's content as necessary. If you completed this challenge by yourself, feel free to delete this section entirely.**

0 commit comments

Comments
 (0)